\hypertarget{classDMatrix}{
\section{DMatrix Class Reference}
\label{classDMatrix}\index{DMatrix@{DMatrix}}
}


\hyperlink{classDMatrix}{DMatrix} class.  




{\ttfamily \#include $<$dmatrixv.h$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{classDMatrix_a414e84e3c2c91900f44b58a9d09d0acc}{input\_\-matrix} ()
\begin{DoxyCompactList}\small\item\em Allows the user to enter the elements of a matrix using command line prompts. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a998b1e7e9dd6c837971f264660075efe}{Print} (const char $\ast$text) const 
\begin{DoxyCompactList}\small\item\em Prints the elements of a \hyperlink{classDMatrix}{DMatrix} object. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a6e471ebaba82f41591b69fdfc8d72eaa}{PrintInfo} (const char $\ast$text) const 
\begin{DoxyCompactList}\small\item\em Prints information about a \hyperlink{classDMatrix}{DMatrix} object. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a12b3c21b0467172f8a6ae976f04a9e99}{Read} (FILE $\ast$filex)
\begin{DoxyCompactList}\small\item\em Reads the elements of a matrix from a file. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a67346b3c1a7e04b0e071e59e06b5399a}{Save} (const char $\ast$FileName)
\begin{DoxyCompactList}\small\item\em Saves the elements of a matrix to a file. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a26e8a17738092057014b0b72ef99c661}{Load} (const char $\ast$FileName)
\begin{DoxyCompactList}\small\item\em Reads the elements of a matrix from a file. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a3470a954caccffa3bec8b134c2e5f179}{Fprint} (FILE $\ast$filex)
\begin{DoxyCompactList}\small\item\em Prints the elements of a matrix elements matrix to a file. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_abebb69fbb1f71d2b49f575153bb36fee}{FillWithZeros} (void)
\begin{DoxyCompactList}\small\item\em Assigns a zero value to each element of a matrix. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a78d654687b6b56497279a81bdc28d4f7}{SwapRows} (int i, int j)
\begin{DoxyCompactList}\small\item\em Swaps two rows of a matrix. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a3b9322caa649274e47049960b1f60a33}{SwapColumns} (int i, int j)
\begin{DoxyCompactList}\small\item\em Swaps two columns of a matrix. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a23e7c1ac8350421a1798a59363452f79}{Transpose} (void)
\begin{DoxyCompactList}\small\item\em Transposes a matrix. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_ae18275d9d832807ea53e4ccb93e461f0}{diag} (const \hyperlink{classDMatrix}{DMatrix} \&dd)
\begin{DoxyCompactList}\small\item\em Assigns values to the diagonal elements of a matrix, while all off-\/diagonal elements are set to zero. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_af2c9e4ddf67ac9cf85141f1afb6cde37}{SetColumn} (const \hyperlink{classDMatrix}{DMatrix} \&Col, int icol)
\begin{DoxyCompactList}\small\item\em Assigns values to a column of a matrix, while other columns are left untouched. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a8cc97e6d3bb30a15c521d822638949eb}{SetRow} (const \hyperlink{classDMatrix}{DMatrix} \&Row, int irow)
\begin{DoxyCompactList}\small\item\em Assigns values to a row of a matrix, while other columns are left untouched. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a54df2f008095aa1ec06ecebce8073c38}{colMult} (long c, double x)
\begin{DoxyCompactList}\small\item\em Multiples the elements of a specified column of a matrix by a constant scalar value. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a3907e2350b967ee27825eb9b9c6f4992}{rowMult} (long r, double x)
\begin{DoxyCompactList}\small\item\em Multiples the elements of a specified row of a matrix by a constant scalar value. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a8b15c0468cccb85d5102e4e1138e8f44}{find} (\hyperlink{classDMatrix}{DMatrix} \&I, \hyperlink{classDMatrix}{DMatrix} \&J) const 
\begin{DoxyCompactList}\small\item\em Finds non-\/zero values of a matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_abf563652a938b64d2074d734584b738c}{find} (int $\ast$I, int $\ast$J) const 
\begin{DoxyCompactList}\small\item\em Finds non-\/zero values of a matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a6c8455bfd3811abb82bca639f2ead3af}{sub\_\-matrix} (long r1, long r2, long c1, long c2) const 
\begin{DoxyCompactList}\small\item\em Extracts a specified sub-\/matrix from a matrix. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a580fc5ea46fe5208dd49a9f1ade06e20}{SetSubMatrix} (long row, long col, const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em Assigns the elements of a matrix object to a section of the calling object. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_ae9ea1cd2a83a4e84e072b62addd825cc}{getn} ()
\begin{DoxyCompactList}\small\item\em Gets the number of rows from the calling object. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_a1954420b4966f38c5ed7e386648f087b}{getm} ()
\begin{DoxyCompactList}\small\item\em Gets the number of columns from the calling object. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_a569af1f26034f5450d059637c9ea909e}{getn} () const 
\begin{DoxyCompactList}\small\item\em Gets the number of rows from the calling object. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_a61fb36c4c0b342f7aabc0c709e761c26}{getm} () const 
\begin{DoxyCompactList}\small\item\em Gets the number of columns from the calling object. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_ac5729ab1d4162789c067ed4928ea86e5}{GetNoRows} ()
\begin{DoxyCompactList}\small\item\em Gets the number of rows from the calling object. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_a45ab6509deee2a3e1a13d27e2b3e929e}{GetNoRows} () const 
\begin{DoxyCompactList}\small\item\em Gets the number of rows from the calling object. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_a16ac005120f99416a8e914aa1119eff1}{GetNoCols} ()
\begin{DoxyCompactList}\small\item\em Gets the number of columns from the calling object. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_a8b234f10a804f49ccf711051ac022156}{GetNoCols} () const 
\begin{DoxyCompactList}\small\item\em Gets the number of columns from the calling object. \item\end{DoxyCompactList}\item 
double $\ast$ \hyperlink{classDMatrix_aeda5a29d08ef2a98344d65ba37fe53b1}{GetPr} ()
\begin{DoxyCompactList}\small\item\em Gets the pointer to the array where the elements of the matrix are stored. \item\end{DoxyCompactList}\item 
double $\ast$ \hyperlink{classDMatrix_a2b8280816c4f3508d522462fd09732cf}{GetConstPr} () const 
\begin{DoxyCompactList}\small\item\em Gets a pointer to the array where the elements of the matrix are stored (for const objects) \item\end{DoxyCompactList}\item 
double $\ast$ \hyperlink{classDMatrix_a48e4e74d3cd7affb6af7d1d0beaca129}{geta} ()
\begin{DoxyCompactList}\small\item\em Gets a pointer to the array where the elements of the matrix are stored. \item\end{DoxyCompactList}\item 
int \hyperlink{classDMatrix_a34b0f1e03bfc35e7e6ac298d21ca78c7}{getatype} ()
\begin{DoxyCompactList}\small\item\em Gets the type of element storage of a matrix. \item\end{DoxyCompactList}\item 
int \hyperlink{classDMatrix_a5616c72557eae51c38af63f6684391d0}{isEmpty} ()
\begin{DoxyCompactList}\small\item\em Check if a matrix object is empty, if other words this method checks if the calling object has zero elements. \item\end{DoxyCompactList}\item 
int \hyperlink{classDMatrix_a05a0f57ed7ed6cc3d57d9294d48ee4cc}{isVector} () const 
\begin{DoxyCompactList}\small\item\em Check if a matrix object contains a row or column vector. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a874f1e4a2796127f8efc9dedfe901603}{element} (long i, long j)
\begin{DoxyCompactList}\small\item\em Returns the value of a specified element of a matrix. \item\end{DoxyCompactList}\item 
double \& \hyperlink{classDMatrix_afbeef8ed62a91eef48e8664f6a9accd0}{elem} (long i, long j)
\begin{DoxyCompactList}\small\item\em Returns a reference to the specified element of a matrix. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_ad07f4bea1e8e45647eb1514c1cb745be}{elem} (long i, long j) const 
\begin{DoxyCompactList}\small\item\em Returns the value of a specified element of a matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_add29fc33eedb04efe3950fcc4c2a31dd}{Column} (long icol) const 
\begin{DoxyCompactList}\small\item\em Returns a \hyperlink{classDMatrix}{DMatrix} object containing a speficied column of the calling object. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a90261694eb6d26818dfbebbe099c1373}{Row} (long irow) const 
\begin{DoxyCompactList}\small\item\em Returns a \hyperlink{classDMatrix}{DMatrix} object containing a speficied row of the calling object. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aeb2c289d9a40b0869f2fef29ffd6340e}{mpow} (int p)
\begin{DoxyCompactList}\small\item\em Computes and returns the integer power of a matrix. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a631c638e92b0b7964f42b11addbaaa01}{
\hyperlink{classDMatrix_a631c638e92b0b7964f42b11addbaaa01}{DMatrix} (void)}
\label{classDMatrix_a631c638e92b0b7964f42b11addbaaa01}

\begin{DoxyCompactList}\small\item\em Default constructor. Creates an empty matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix_ae3911763fdae4b6f4d41772031c9a2da}{DMatrix} (long Initn, long Initm)
\begin{DoxyCompactList}\small\item\em Constructor with dimensions. Creates a matrix with allocated storage given specified numbers of rows and columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix_a4751cd36f1eb0b65f4c25eced0142192}{DMatrix} (long vDim, double $\ast$v, long Initn, long Initm)
\begin{DoxyCompactList}\small\item\em Constructor with dimensions using pre-\/allocated storage. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix_a7e8d467c27e1dc57c2cdae0c28efea21}{DMatrix} (long Initn)
\begin{DoxyCompactList}\small\item\em Constructor with a single dimension, creates a column vector. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix_a823b4bf5f2957ea5c2d9339292237234}{DMatrix} (long Initn, long Initm, double a11,...)
\begin{DoxyCompactList}\small\item\em Constructor using a variable list of element values. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix_af8ff7b8c264b0390e20c2c9c58a03b64}{DMatrix} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em Copy constructor. Creates a new \hyperlink{classDMatrix}{DMatrix} object with the same dimensions and element values as a given \hyperlink{classDMatrix}{DMatrix} object. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a06129166d2e2166192f1f35841d1c0e5}{
\hyperlink{classDMatrix_a06129166d2e2166192f1f35841d1c0e5}{$\sim$DMatrix} ()}
\label{classDMatrix_a06129166d2e2166192f1f35841d1c0e5}

\begin{DoxyCompactList}\small\item\em Destructor. Destroys a previously created \hyperlink{classDMatrix}{DMatrix} object and frees any allocated memory. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a523236d1477888fc53f74bbc00a30fa6}{Resize} (long nnrow, long nncol)
\begin{DoxyCompactList}\small\item\em Changes the number of rows and columns of an existing matrix. Allocates new memory if necessary. If the calling object uses preallocated memory and the requested size would exceed that memory, an error is thrown. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_ab8c6ade7a8a3cfaae690572887575fdc}{assign} (long rows, long columns, double a11,...)
\begin{DoxyCompactList}\small\item\em Assigns values to the elements of an existing \hyperlink{classDMatrix}{DMatrix} object using a variable list of values. Resizes the matrix if necessary. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a0363c3677623145f180fe42d294c6ede}{MemCpyArray} (double $\ast$aptr)
\begin{DoxyCompactList}\small\item\em Copies values to the elements of a \hyperlink{classDMatrix}{DMatrix} object from an existing array. The number of elements of the \hyperlink{classDMatrix}{DMatrix} object is assumed to be the number of values to be copied. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac87ec83dbff242d422e1cb369bd2ca88}{operator+} (const \hyperlink{classDMatrix}{DMatrix} \&rval) const 
\begin{DoxyCompactList}\small\item\em Matrix addition operator. The sizes of the matrices being added should be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_add9bb19634bb522c9e877491094e738c}{operator+=} (const \hyperlink{classDMatrix}{DMatrix} \&rval)
\begin{DoxyCompactList}\small\item\em Matrix addition and substitution operator. The sizes of the matrices being added should be the same, otherwise an error is thrown.The left hand side object elements are replaced with the result of the operation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a666ade216863c56a4c349bb8fee0b972}{operator+} (double x) const 
\begin{DoxyCompactList}\small\item\em Adds a scalar real value to each element of the matrix. . \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a9535ca71463a4e2f687b680569c9dd75}{operator-\/=} (const \hyperlink{classDMatrix}{DMatrix} \&rval)
\begin{DoxyCompactList}\small\item\em Matrix subtraction and substitution operator. The sizes of the matrices being subtracted should be the same, otherwise an error is thrown.The left hand side object elements are replaced with the result of the operation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_adf28e5ff346309620d9dded905cf5b22}{operator-\/} (const \hyperlink{classDMatrix}{DMatrix} \&rval) const 
\begin{DoxyCompactList}\small\item\em Matrix subtraction operator. The sizes of the matrices being subtracted should be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac0a611dd59097d0a3920abf376d054e7}{operator-\/} (double x) const 
\begin{DoxyCompactList}\small\item\em Subtracts a scalar real value from each element of the matrix. . \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a17a7fbea90ec8a16e4ced726128d4b5f}{operator$\ast$} (const \hyperlink{classDMatrix}{DMatrix} \&rval) const 
\begin{DoxyCompactList}\small\item\em Matrix product operator. Returns the result of the matrix product of the calling object (left hand side of the operator) and the right hand side object. The inner dimensions of the objects being multiplied should be consistent, otherwise an error will be thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_abda7d982b252b058549dbe48ec1276ba}{operator$\ast$=} (const \hyperlink{classDMatrix}{DMatrix} \&rval)
\begin{DoxyCompactList}\small\item\em Matrix product operator with substitution. Computes the matrix product of the calling object (left hand side of the operator) and the right hand side object. The inner dimensions of the objects being multiplied should be consistent, otherwise an error will be thrown. The calling object is modified to store the results of the operation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a671296ddd1c619d1ee31a308ac56840c}{operator$\ast$} (double Arg) const 
\begin{DoxyCompactList}\small\item\em Computes the product of a matrix (left hand side of the operator) times a real scalar (right hand side value) and replaces the left hand side object with the result of the operation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_afe1c2b5daad8e441bb1da8edeccbe6a2}{operator$\ast$=} (double Arg)
\begin{DoxyCompactList}\small\item\em Computes the product of a matrix (left hand side of the operator) times a real scalar (right hand side value), and modifies the calling object to store the result of the operation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ae58c7f379fbb88acad6b704961f7029c}{operator/} (double Arg) const 
\begin{DoxyCompactList}\small\item\em Computes the division of a matrix (left hand side of the operator) by a real scalar (right hand side value). \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a3b8d471ba4ef3cd2e9dc5931e5b77e01}{operator/} (const \hyperlink{classDMatrix}{DMatrix} \&rval) const 
\begin{DoxyCompactList}\small\item\em Computes the right division of a matrix (left hand side of the operator) by another matrix (right hand side value). This is conceptually equivalent to multiplying the left object by the inverse of the right hand side object but it is computed in a more efficient way. The dimensions of the matrices must be consistent, otherwise an error is returned. The right hand side object must be a square matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aa26baf81cd578c80fed72d7b6179ad1f}{operator\%} (const \hyperlink{classDMatrix}{DMatrix} \&rval) const 
\begin{DoxyCompactList}\small\item\em Computes the left division of a matrix (left hand side of the operator) by another matrix (right hand side value). This is conceptually equivalent to multiplying the inverse of the left object by the right hand side object but it is computed in a more efficient way. The dimensions of the matrices must be consistent, otherwise an error is returned. The left hand side object must be a square matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ab57902d452e18ec32edbfb300a59940f}{operator/=} (double Arg)
\begin{DoxyCompactList}\small\item\em Computes the division of a matrix (left hand side of the operator) by a real scalar (right hand side value) and modifies the left hand side object with the result of the operation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_add548c8713cb71b189a0535d05a37cc9}{operator=} (const \hyperlink{classDMatrix}{DMatrix} \&rval)
\begin{DoxyCompactList}\small\item\em Matrix assignment. The size of the left hand side object is modified if necessary, and the values of all real elements of the right hand side object and copied to the left hand side object. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_af94a79c28f61abb7ef91c97a5113f2d4}{operator=} (double val)
\begin{DoxyCompactList}\small\item\em Matrix assignment to a scalar. The size of the left hand side object is modified to one row by one column if necessary, and the value of the right hand side argument is copied to the single element of the matrix. If the calling object is a \char`\"{}colon reference\char`\"{} matrix, then the right hand side value is copied to each element of the referenced array elements. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a5625e608ef4e437bdce83858df5b3c97}{operator=} (const char $\ast$str)
\begin{DoxyCompactList}\small\item\em Matrix assignment to a constant matrix defined as a character string using the bracket notation used in Matlab and Octave. The size of the left hand side object is modified if necessary. For example, the identity matrix of size two by two would be entered as \char`\"{}\mbox{[}1.0  0.0;0.0  1.0\mbox{]}\char`\"{}. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a7b756f28bc990d6b5b67a176143b9fc0}{operator$|$$|$} (const \hyperlink{classDMatrix}{DMatrix} \&B) const 
\begin{DoxyCompactList}\small\item\em Concatenates two matrices side by side. The dimensions number of rows of the matrices involved must be the same, otherwise an error is thrown. The number of columns of the resulting matrix is the addition of the number of columns of both matrices involved. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a0346b7c7d5952c7dbae995150ee40476}{operator\&\&} (const \hyperlink{classDMatrix}{DMatrix} \&B) const 
\begin{DoxyCompactList}\small\item\em Stacks the right hand side matrix below the left hand side matrix. The dimensions number of columns of the matrices involved must be the same, otherwise an error is thrown. The number of rows of the resulting matrix is the addition of the number of rows of both matrices involved. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_af380c4e561b0f321b5bf7103038fa2cb}{operator$^\wedge$} (double x)
\begin{DoxyCompactList}\small\item\em Elementwise power operator. Returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions of the calling object and each of its elements is computed as the corresponding element of the calling object to the power of the right hand side argument. Care must be taken when using this operator as the associations do not work in the same way as with the $\ast$ operator. It is highly recommended to use parenthesis every time this operator is used. For example use it as follows: (A$^\wedge$x). \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a051fc52a9620318d04dd454d7970d319}{operator\&} (const \hyperlink{classDMatrix}{DMatrix} B) const 
\begin{DoxyCompactList}\small\item\em Elementwise product operator. Returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions of the calling objects and each of its elements is computed as the product of the corresponding elements of the calling object and the right hand side object. The dimensions of the calling objects must be the same, otherwise an error is thrown. Care must be taken when using this operator as the associations do not work in the same way as with the $\ast$ operator. It is highly recommended to use parenthesis every time this operator is used. For example use it as follows: (A\&B). \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ada9cc203a754a96ac3cb6122c9eba0fd}{operator$|$} (const \hyperlink{classDMatrix}{DMatrix} B) const 
\begin{DoxyCompactList}\small\item\em Elementwise division operator. Returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions of the calling objects and each of its elements is computed as the of the corresponding element of the calling object by the corresponding element of the right hand side object. The dimensions of the calling objects must be the same, otherwise an error is thrown. Care must be taken when using this operator as the associations do not work in the same way as with the / operator. It is highly recommended to use parenthesis every time this operator is used. For example use it as follows: (A$|$B). \item\end{DoxyCompactList}\item 
double \& \hyperlink{classDMatrix_ad944a2f5b2df21a1ae752f368e257f34}{operator()} (long row, long col)
\begin{DoxyCompactList}\small\item\em Matrix indexing. Returns a reference to the matrix element located at the position indicated by the row and column indices. Indices start from 1. \item\end{DoxyCompactList}\item 
double \& \hyperlink{classDMatrix_a15adc46b55cb516b67bb408447f8275e}{operator()} (long row, const char $\ast$end)
\begin{DoxyCompactList}\small\item\em Matrix indexing. Returns a reference to the matrix element located at the position indicated by the row index and the last column. Indices start from 1. An error in thrown in case of zero or negative indices. The matrix is resized if necessary. \item\end{DoxyCompactList}\item 
double \& \hyperlink{classDMatrix_a430e6b0a88061c4fe70e1c64ccaf285a}{operator()} (const char $\ast$end, long col)
\begin{DoxyCompactList}\small\item\em Matrix indexing. Returns a reference to the matrix element located at the position indicated by the column index and the last row. Indices start from 1. An error in thrown in case of a range violation. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a1e736f0992464a5d849ebbe5a4eb3bbf}{operator()} (long row, long col) const 
\begin{DoxyCompactList}\small\item\em Matrix indexing. Returns the value of the matrix element located at the position indicated by the row and column indices. Indices start from 1. An error in thrown in case of a range violation. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_aafb023a91a09e10f3c95414b29a32d22}{operator()} (long row, const char $\ast$end) const 
\begin{DoxyCompactList}\small\item\em Matrix indexing. Returns the value of the matrix element located at the position indicated by the row index and the last column. Indices start from 1. An error in thrown in case of a range violation. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_aca1e6c7d7c8859a705bc87674003a194}{operator()} (const char $\ast$end, long col) const 
\begin{DoxyCompactList}\small\item\em Matrix indexing. Returns the value of the matrix element located at the position indicated by the column index and the last row. Indices start from 1. An error in thrown in case of a range violation. \item\end{DoxyCompactList}\item 
double \& \hyperlink{classDMatrix_a6f6ad5489850d8200b6a49c9da098877}{operator()} (long index)
\begin{DoxyCompactList}\small\item\em Single index matrix indexing. Returns a reference to the matrix element located at the linear position indicated by the index, assuming column major storage. The indexs start from 1. The matrix is resized if necessary. An error is thrown in case of zero or negative indices. \item\end{DoxyCompactList}\item 
double \& \hyperlink{classDMatrix_a8a1118191a95c48e44043ddb89dbd826}{operator()} (const char $\ast$end)
\begin{DoxyCompactList}\small\item\em Access to last linear element. Returns a reference to the last linear matrix element, assuming column major storage. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a181f357abea59bca3f4d9efb16fb5618}{operator()} (long k) const 
\begin{DoxyCompactList}\small\item\em Single index matrix indexing. Returns the value of the matrix element located at the linear position indicated by the index, assuming column major storage. The index starts from 1. An error is thrown in case of range error. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a107a1b256e91c653cd48a863ba063494}{operator()} (const char $\ast$end) const 
\begin{DoxyCompactList}\small\item\em Access to last linear element. Returns the value of the last linear matrix element, assuming column major storage. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac13b6fc14bdd5f3947cccb8f41173433}{operator$>$} (double val) const 
\begin{DoxyCompactList}\small\item\em Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is greater than the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a60f1f1c8766a649c91c64243a7f37b77}{operator$<$} (double val) const 
\begin{DoxyCompactList}\small\item\em Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is lower than the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_adf2cf4223a098eb273fd3b6c71fea201}{operator$>$=} (double val) const 
\begin{DoxyCompactList}\small\item\em Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is greater or equal than the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a2f0eadd7bb2b7afc5e6109243a839c1d}{operator$<$=} (double val) const 
\begin{DoxyCompactList}\small\item\em Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is lower or equal than the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a02a8277b7f165d774d6463f284bb71b4}{operator==} (double val) const 
\begin{DoxyCompactList}\small\item\em Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is equal to the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a475f14adcb18e617464bd66021fc4ca2}{operator!=} (double val) const 
\begin{DoxyCompactList}\small\item\em Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is different from the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a1cb2ee04434b9874b01bc1494f49c639}{operator$>$} (const \hyperlink{classDMatrix}{DMatrix} \&val) const 
\begin{DoxyCompactList}\small\item\em Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is greater than the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac488bfc1076b6e69fdb8cb8e37acdff4}{operator$<$} (const \hyperlink{classDMatrix}{DMatrix} \&val) const 
\begin{DoxyCompactList}\small\item\em Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is lower than the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac17447effdb7cfc9252bf5232c3e99d6}{operator$>$=} (const \hyperlink{classDMatrix}{DMatrix} \&val) const 
\begin{DoxyCompactList}\small\item\em Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is greater or equal than the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a220c708ecc6554de0abf07788eb9ab89}{operator$<$=} (const \hyperlink{classDMatrix}{DMatrix} \&val) const 
\begin{DoxyCompactList}\small\item\em Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is lower or equal than the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a9851dca0d4acb9001926dfef3d4226b8}{operator==} (const \hyperlink{classDMatrix}{DMatrix} \&val) const 
\begin{DoxyCompactList}\small\item\em Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is equal to the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a50d36066d7917dee27b67665b91d78a3}{operator!=} (const \hyperlink{classDMatrix}{DMatrix} \&val) const 
\begin{DoxyCompactList}\small\item\em Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is different from the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a2716e6ec24ea80068a5baec55e98c370}{operator()} (const \hyperlink{classDMatrix}{DMatrix} \&RowIndx, const \hyperlink{classDMatrix}{DMatrix} \&ColIndx)
\begin{DoxyCompactList}\small\item\em Submatrix extraction and referencing using arrays of indices. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a160cbc57bd615ceb60ebdb500371a37c}{operator()} (const \hyperlink{classDMatrix}{DMatrix} \&RowIndx)
\begin{DoxyCompactList}\small\item\em Linear sub-\/vector extraction and referencing using an array of indices assuming column-\/major storage. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aad182b5dbdaa8ec1911904639d5626de}{operator()} (const \hyperlink{classDMatrix}{DMatrix} \&RowIndx, long col)
\begin{DoxyCompactList}\small\item\em Sub-\/vector extraction and referencing using an array of row indices for a given column. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_af44540d97b6e449fd3f1551956ea2518}{operator()} (long row, const \hyperlink{classDMatrix}{DMatrix} \&ColIndx)
\begin{DoxyCompactList}\small\item\em Sub-\/vector extraction and referencing using an array of column indices for a given row. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a847dc65e8a09a3274b7a6e54acb37a17}{operator()} (const \hyperlink{classDMatrix}{DMatrix} \&RowIndx, const char $\ast$end)
\begin{DoxyCompactList}\small\item\em Sub-\/vector extraction and referencing using an array of row indices for the last column of a matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ad9815228adc3856c7cdc8ecca281d5a3}{operator()} (const char $\ast$end, const \hyperlink{classDMatrix}{DMatrix} \&ColIndx)
\begin{DoxyCompactList}\small\item\em Sub-\/vector extraction and referencing using an array of column indices for the last column of a matrix. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static void \hyperlink{classDMatrix_aadec35682639717d9bc698cfee3953ad}{AllocateAuxArr} (void)
\begin{DoxyCompactList}\small\item\em Allocates the array of auxiliary (temporary) objects used by the class. \item\end{DoxyCompactList}\item 
static void \hyperlink{classDMatrix_a6389bc3790f8b71dd59a8f2bd659fc27}{DeAllocateAuxArr} (void)
\begin{DoxyCompactList}\small\item\em De-\/allocates the array of auxiliary (temporary) objects previously allocated by \hyperlink{classDMatrix_aadec35682639717d9bc698cfee3953ad}{AllocateAuxArr()} \item\end{DoxyCompactList}\item 
static double \hyperlink{classDMatrix_a02bef7569ab47374e79f9acd9fa517b2}{random\_\-uniform} (void)
\begin{DoxyCompactList}\small\item\em Returns a pseudo-\/random uniformly distributed number in the range \mbox{[}0,1\mbox{]}. \item\end{DoxyCompactList}\item 
static double \hyperlink{classDMatrix_ac79a34758fce637c1f23149f267ed623}{random\_\-gaussian} (void)
\begin{DoxyCompactList}\small\item\em Returns a pseudo-\/random Gaussian distributed number with zero mean and unit variance. \item\end{DoxyCompactList}\item 
static \hyperlink{classDMatrix}{DMatrix} $\ast$$\ast$ \hyperlink{classDMatrix_adfa26d6b647b74af5f592d51bf70e8f4}{GetAuxPr} (void)
\begin{DoxyCompactList}\small\item\em Gets a pointer to the array of auxiliary objects. \item\end{DoxyCompactList}\item 
static int \hyperlink{classDMatrix_a3c854cc931571f2eba43f374e17ff18d}{isThereError} (void)
\begin{DoxyCompactList}\small\item\em Checks if the error flag has been raised. If so, a 1 is returned, 0 otherwise. \item\end{DoxyCompactList}\item 
static void \hyperlink{classDMatrix_a7521e5968a095edd6b80779f95b25309}{SetPrintLevel} (int plevel)
\begin{DoxyCompactList}\small\item\em Sets the print level. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_af784203b9838e92c481ab977498cfeb9}{
static int {\bfseries PrintLevel} ()}
\label{classDMatrix_af784203b9838e92c481ab977498cfeb9}

\item 
\hypertarget{classDMatrix_a8b81363f7e8e3eeef78851fa149b806f}{
static double \hyperlink{classDMatrix_a8b81363f7e8e3eeef78851fa149b806f}{GetEPS} ()}
\label{classDMatrix_a8b81363f7e8e3eeef78851fa149b806f}

\begin{DoxyCompactList}\small\item\em This function returns the machine numerical precision. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classDMatrix_a45db94207b6ce1580b2b280d620de7dd}{
void \hyperlink{classDMatrix_a45db94207b6ce1580b2b280d620de7dd}{SetAuxFlag} (int arg)}
\label{classDMatrix_a45db94207b6ce1580b2b280d620de7dd}

\begin{DoxyCompactList}\small\item\em Sets the value of auxFlag. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ac4fb297fbf91ef6f520158636ad85f4e}{
int \hyperlink{classDMatrix_ac4fb297fbf91ef6f520158636ad85f4e}{GetAuxFlag} ()}
\label{classDMatrix_ac4fb297fbf91ef6f520158636ad85f4e}

\begin{DoxyCompactList}\small\item\em Gets the value of auxFlag. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_ac643c444a18419885b5ac5a2f8d003be}{Allocate} (long size)
\begin{DoxyCompactList}\small\item\em Allocate memory to store matrix elements. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a077cd396523652629a258cb11f469886}{DeAllocate} ()
\begin{DoxyCompactList}\small\item\em De-\/allocate memory previously allocated with \hyperlink{classDMatrix_ac643c444a18419885b5ac5a2f8d003be}{DMatrix::Allocate()}. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a8935b0337db48a93dd91cb87c698b291}{compMat} (const \hyperlink{classDMatrix}{DMatrix} \&m2, char op) const 
\begin{DoxyCompactList}\small\item\em Elementwise comparison of matrix elements. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_ac13795ccdc5f59c8bcec90207f484fe8}{SetReferencedDMatrixPointer} (\hyperlink{classDMatrix}{DMatrix} $\ast$arg)
\begin{DoxyCompactList}\small\item\em Sets the value of the referenced matrix pointer. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} $\ast$ \hyperlink{classDMatrix_a9bb99d0f897fe9e23b5370e11bf80d3f}{GetReferencedDMatrixPointer} ()
\begin{DoxyCompactList}\small\item\em Gets the value of the referenced matrix pointer. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a73b829dadf5b159839b57a399f1fa8c8}{SetRowIndexPointer} (const \hyperlink{classDMatrix}{DMatrix} $\ast$arg)
\begin{DoxyCompactList}\small\item\em Sets the row index pointer. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a877dbfd1042abd3391f77a4aaf90c296}{SetColIndexPointer} (const \hyperlink{classDMatrix}{DMatrix} $\ast$arg)
\begin{DoxyCompactList}\small\item\em Sets the column index pointer. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_aeb006280bc37e1d13ecf16164fff0f5c}{SetMType} (int arg)
\begin{DoxyCompactList}\small\item\em Sets the type of matrix. \item\end{DoxyCompactList}\item 
int \hyperlink{classDMatrix_a8617eafafa13e38ba6dd7d0265b1c9a3}{GetMType} ()
\begin{DoxyCompactList}\small\item\em Gets the type of matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a9630eee5b92eb0b651789204f91b55e7}{AssignmentToColonReference} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em Assigns a matrix to the values pointed to by a colon reference matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac4080d0de15b606eac2a3e0ab34a8e13}{AssignmentToColonReference} (double arg)
\begin{DoxyCompactList}\small\item\em Assigns a double value to each value pointed to by a colon reference matrix. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classDMatrix_a219884cf7cdede14bf16b1e2f72b8519}{
static \hyperlink{classDMatrix}{DMatrix} $\ast$ \hyperlink{classDMatrix_a219884cf7cdede14bf16b1e2f72b8519}{GetTempPr} (int i)}
\label{classDMatrix_a219884cf7cdede14bf16b1e2f72b8519}

\begin{DoxyCompactList}\small\item\em returns pointer to the i-\/th temporary object \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_acd872a02e93bdabb985544e6f2dfcce5}{
static int \hyperlink{classDMatrix_acd872a02e93bdabb985544e6f2dfcce5}{GetMemberFlag} ()}
\label{classDMatrix_acd872a02e93bdabb985544e6f2dfcce5}

\begin{DoxyCompactList}\small\item\em Gets the memberFlag value from the object. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a720e5aedc8031aa796b2f176a3baafff}{
static void \hyperlink{classDMatrix_a720e5aedc8031aa796b2f176a3baafff}{SetMemberFlag} (int arg)}
\label{classDMatrix_a720e5aedc8031aa796b2f176a3baafff}

\begin{DoxyCompactList}\small\item\em Sets the memberFlag value. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a627d51c532b05cff96fe700d403935d1}{
static void \hyperlink{classDMatrix_a627d51c532b05cff96fe700d403935d1}{ChkAuxArrays} ()}
\label{classDMatrix_a627d51c532b05cff96fe700d403935d1}

\begin{DoxyCompactList}\small\item\em Checks the auxiliary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a0c91bf06a776242d7d6ad0a7542f6941}{
static int \hyperlink{classDMatrix_a0c91bf06a776242d7d6ad0a7542f6941}{GetNoAuxArr} ()}
\label{classDMatrix_a0c91bf06a776242d7d6ad0a7542f6941}

\begin{DoxyCompactList}\small\item\em Gets the number of temporary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a591f532e37974cc25ebc194e9fc7d7e3}{
static long \hyperlink{classDMatrix_a591f532e37974cc25ebc194e9fc7d7e3}{GetDimAux} ()}
\label{classDMatrix_a591f532e37974cc25ebc194e9fc7d7e3}

\begin{DoxyCompactList}\small\item\em Gets the dimensions of the array of temporary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a14abde5d3504796b201a0202a8970f51}{
static int \hyperlink{classDMatrix_a14abde5d3504796b201a0202a8970f51}{GetInitFlag} ()}
\label{classDMatrix_a14abde5d3504796b201a0202a8970f51}

\begin{DoxyCompactList}\small\item\em Gets the value of initFlag. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a8cef5f97f92074b16625846b8f550df1}{
static void \hyperlink{classDMatrix_a8cef5f97f92074b16625846b8f550df1}{SetInitFlag} (int arg)}
\label{classDMatrix_a8cef5f97f92074b16625846b8f550df1}

\begin{DoxyCompactList}\small\item\em Sets the value of initFlag. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ace53a9ed8bb434bc0a67b1f069316f9f}{
static int \hyperlink{classDMatrix_ace53a9ed8bb434bc0a67b1f069316f9f}{GetAuxIndx} ()}
\label{classDMatrix_ace53a9ed8bb434bc0a67b1f069316f9f}

\begin{DoxyCompactList}\small\item\em Gets the current index of temporary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ab4a11314f2975a137017e2d57cd3e5d5}{
static int \hyperlink{classDMatrix_ab4a11314f2975a137017e2d57cd3e5d5}{IncrementAuxIndx} ()}
\label{classDMatrix_ab4a11314f2975a137017e2d57cd3e5d5}

\begin{DoxyCompactList}\small\item\em Increments the index of temporary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a2211b735aecd50ed6762ed92de52a547}{
static int \hyperlink{classDMatrix_a2211b735aecd50ed6762ed92de52a547}{DecrementAuxIndx} ()}
\label{classDMatrix_a2211b735aecd50ed6762ed92de52a547}

\begin{DoxyCompactList}\small\item\em Decrements the index of temporary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ae65a4d724762861f0be576fccd5f9268}{
static void \hyperlink{classDMatrix_ae65a4d724762861f0be576fccd5f9268}{SetAuxIndx} (int i)}
\label{classDMatrix_ae65a4d724762861f0be576fccd5f9268}

\begin{DoxyCompactList}\small\item\em Sets the index of temporary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a869b844f16fb6cbd67a6ae49ce9e85ba}{
static void \hyperlink{classDMatrix_a869b844f16fb6cbd67a6ae49ce9e85ba}{SetDimAux} (long dd)}
\label{classDMatrix_a869b844f16fb6cbd67a6ae49ce9e85ba}

\begin{DoxyCompactList}\small\item\em Sets the dimension of each object in the array of temporary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a0206fa2a95f063d9dc2da4b3bad1bddb}{
static void \hyperlink{classDMatrix_a0206fa2a95f063d9dc2da4b3bad1bddb}{SetNoAuxArr} (int nn)}
\label{classDMatrix_a0206fa2a95f063d9dc2da4b3bad1bddb}

\begin{DoxyCompactList}\small\item\em Sets the number of auxiliary objects. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_afa61b704944672add882239a0c59c0c2}{
static void \hyperlink{classDMatrix_afa61b704944672add882239a0c59c0c2}{RiseErrorFlag} ()}
\label{classDMatrix_afa61b704944672add882239a0c59c0c2}

\begin{DoxyCompactList}\small\item\em Sets the errorFlag member to true. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ab8b0bcf34072a17bbfbbccfb4bdc3854}{
static clock\_\-t \hyperlink{classDMatrix_ab8b0bcf34072a17bbfbbccfb4bdc3854}{GetStartTicks} (void)}
\label{classDMatrix_ab8b0bcf34072a17bbfbbccfb4bdc3854}

\begin{DoxyCompactList}\small\item\em Gets the value of start\_\-clock member. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a13b4271744d10ea297a889ec7077857b}{
static void \hyperlink{classDMatrix_a13b4271744d10ea297a889ec7077857b}{SetStartTicks} (clock\_\-t st)}
\label{classDMatrix_a13b4271744d10ea297a889ec7077857b}

\begin{DoxyCompactList}\small\item\em Sets the value of start\_\-clock member. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classDMatrix_a3857b87c430ba8cc0113f0988daf6893}{
double $\ast$ \hyperlink{classDMatrix_a3857b87c430ba8cc0113f0988daf6893}{a}}
\label{classDMatrix_a3857b87c430ba8cc0113f0988daf6893}

\begin{DoxyCompactList}\small\item\em Array of doubles to store matrix elements using column major storage. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{
long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}}
\label{classDMatrix_a6b7668991ff7d01230b3599836a5d682}

\begin{DoxyCompactList}\small\item\em Number of matrix rows. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}{
long \hyperlink{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}{m}}
\label{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}

\begin{DoxyCompactList}\small\item\em Number of matrix columns. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_af74d7ca8df8470885972d41500a27ff7}{
long \hyperlink{classDMatrix_af74d7ca8df8470885972d41500a27ff7}{asize}}
\label{classDMatrix_af74d7ca8df8470885972d41500a27ff7}

\begin{DoxyCompactList}\small\item\em Number of allocated elements in a. \item\end{DoxyCompactList}\item 
int \hyperlink{classDMatrix_a7d862f142821d27ff3ca0620170428ba}{atype}
\item 
int \hyperlink{classDMatrix_a1b72a6547b064c5e262e5db9389b34f4}{mtype}
\item 
\hypertarget{classDMatrix_a94587c0c67c81ca027a6fa0db7968dee}{
int \hyperlink{classDMatrix_a94587c0c67c81ca027a6fa0db7968dee}{auxFlag}}
\label{classDMatrix_a94587c0c67c81ca027a6fa0db7968dee}

\begin{DoxyCompactList}\small\item\em Flag to indicate auxiliary (temporary) matrix flag = 1 if temporary matrix, 0 otherwise. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ae25aeefd7343fa1c4e2af40b58ea6417}{
int \hyperlink{classDMatrix_ae25aeefd7343fa1c4e2af40b58ea6417}{allocated}}
\label{classDMatrix_ae25aeefd7343fa1c4e2af40b58ea6417}

\begin{DoxyCompactList}\small\item\em Flag to indicate that element storage has been allocated. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_aeac61a503c71ccb91ed1716b2783929b}{
\hyperlink{classDMatrix}{DMatrix} $\ast$ \hyperlink{classDMatrix_aeac61a503c71ccb91ed1716b2783929b}{mt}}
\label{classDMatrix_aeac61a503c71ccb91ed1716b2783929b}

\begin{DoxyCompactList}\small\item\em Referenced matrix pointer. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a65ac7d1345a971d77e67ee703c2a2810}{
const \hyperlink{classDMatrix}{DMatrix} $\ast$ \hyperlink{classDMatrix_a65ac7d1345a971d77e67ee703c2a2810}{rowIndx}}
\label{classDMatrix_a65ac7d1345a971d77e67ee703c2a2810}

\begin{DoxyCompactList}\small\item\em Row indices. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a07458d7c2b1b8de8e8c999b9599f4b8b}{
const \hyperlink{classDMatrix}{DMatrix} $\ast$ \hyperlink{classDMatrix_a07458d7c2b1b8de8e8c999b9599f4b8b}{colIndx}}
\label{classDMatrix_a07458d7c2b1b8de8e8c999b9599f4b8b}

\begin{DoxyCompactList}\small\item\em Column indices. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classDMatrix_a8e0787660169ccbbbe03abfe35cfa2bb}{
static \hyperlink{classDMatrix}{DMatrix} $\ast$ \hyperlink{classDMatrix_a8e0787660169ccbbbe03abfe35cfa2bb}{auxPr}}
\label{classDMatrix_a8e0787660169ccbbbe03abfe35cfa2bb}

\begin{DoxyCompactList}\small\item\em Array of Temporary matrices. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a56775df03984b80a3d42399b7ab76fce}{
static int \hyperlink{classDMatrix_a56775df03984b80a3d42399b7ab76fce}{noAuxArr}}
\label{classDMatrix_a56775df03984b80a3d42399b7ab76fce}

\begin{DoxyCompactList}\small\item\em Number of auxiliary matrices. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a5bb25eb7096e0e1e23a3d8060f022604}{
static long \hyperlink{classDMatrix_a5bb25eb7096e0e1e23a3d8060f022604}{dimAux}}
\label{classDMatrix_a5bb25eb7096e0e1e23a3d8060f022604}

\begin{DoxyCompactList}\small\item\em Dimension of auxiliary arrays. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a4751f59f6b2d9ca38bc86861356daacb}{
static int \hyperlink{classDMatrix_a4751f59f6b2d9ca38bc86861356daacb}{auxIndx}}
\label{classDMatrix_a4751f59f6b2d9ca38bc86861356daacb}

\begin{DoxyCompactList}\small\item\em Index of used auxiliary matrices. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a5ea72e70cde471344b0cb5fa4a5c2652}{
static int \hyperlink{classDMatrix_a5ea72e70cde471344b0cb5fa4a5c2652}{memberFlag}}
\label{classDMatrix_a5ea72e70cde471344b0cb5fa4a5c2652}

\begin{DoxyCompactList}\small\item\em Member function flag to control resetting of auxIndx. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a372c2986dfa355aa97371f996b5daa48}{
static int \hyperlink{classDMatrix_a372c2986dfa355aa97371f996b5daa48}{initFlag}}
\label{classDMatrix_a372c2986dfa355aa97371f996b5daa48}

\begin{DoxyCompactList}\small\item\em Flag to indicate aux arrays allocation. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_afc8acc5933599402803919f0536d8afa}{
static const double \hyperlink{classDMatrix_afc8acc5933599402803919f0536d8afa}{MACH\_\-EPS}}
\label{classDMatrix_afc8acc5933599402803919f0536d8afa}

\begin{DoxyCompactList}\small\item\em Machine precision constant. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ac1534658aee6a96156f92f0c124cf805}{
static int \hyperlink{classDMatrix_ac1534658aee6a96156f92f0c124cf805}{errorFlag}}
\label{classDMatrix_ac1534658aee6a96156f92f0c124cf805}

\begin{DoxyCompactList}\small\item\em Flag to indicate error condition. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_aac5e51f153fa877df6a37998a663a80f}{
static int \hyperlink{classDMatrix_aac5e51f153fa877df6a37998a663a80f}{print\_\-level}}
\label{classDMatrix_aac5e51f153fa877df6a37998a663a80f}

\begin{DoxyCompactList}\small\item\em Print level flag, 1: output sent to sderr, 0: no output sent. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_abc1151795b37eb105f0a56cff7f0dbd9}{
static long \hyperlink{classDMatrix_abc1151795b37eb105f0a56cff7f0dbd9}{seed} \mbox{[}$\,$\mbox{]}}
\label{classDMatrix_abc1151795b37eb105f0a56cff7f0dbd9}

\begin{DoxyCompactList}\small\item\em current state of each stream \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ad0fa6340a823be80a8ff8334ca4ffa36}{
static int \hyperlink{classDMatrix_ad0fa6340a823be80a8ff8334ca4ffa36}{stream}}
\label{classDMatrix_ad0fa6340a823be80a8ff8334ca4ffa36}

\begin{DoxyCompactList}\small\item\em stream index for pseudo-\/ramdon number generator \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_a67f6d06df5d5c3ffc5259b17353af8a2}{
static time\_\-t \hyperlink{classDMatrix_a67f6d06df5d5c3ffc5259b17353af8a2}{start\_\-time}}
\label{classDMatrix_a67f6d06df5d5c3ffc5259b17353af8a2}

\begin{DoxyCompactList}\small\item\em variable to store start time after \hyperlink{classDMatrix_ace51fd7d8435f88c8b2b3bcf64367673}{tic()} call. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ad01743f08b2cffeaf5e212765adcdda0}{
static clock\_\-t \hyperlink{classDMatrix_ad01743f08b2cffeaf5e212765adcdda0}{start\_\-clock}}
\label{classDMatrix_ad01743f08b2cffeaf5e212765adcdda0}

\begin{DoxyCompactList}\small\item\em clock\_\-t variable \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Friends}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{classDMatrix_ae96d9db92ff5e3a72e0e7b0eda05490f}{CholeskyDecomp} (\hyperlink{classDMatrix}{DMatrix} \&A, int \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}, \hyperlink{classDMatrix}{DMatrix} \&pM)
\begin{DoxyCompactList}\small\item\em Cholesky decomposition of a matrix. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_ac66ec50116a7b447a9ba3d0cc38043eb}{CholeskySolution} (const \hyperlink{classDMatrix}{DMatrix} \&A, int \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}, const \hyperlink{classDMatrix}{DMatrix} \&pM, const \hyperlink{classDMatrix}{DMatrix} \&bM, \hyperlink{classDMatrix}{DMatrix} \&xM)
\begin{DoxyCompactList}\small\item\em Cholesky solution using the Cholesky decomposition of a matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac100c02f140686e07a7b520bf5a58e25}{operator-\/} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em Matrix unary minus operator. Returns an object of the same dimensions as A but with changed element signs. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ab52a3e622e1d9bab78e860842f5dd983}{colon} (double i1, double increment, double i2)
\begin{DoxyCompactList}\small\item\em This function generates a \hyperlink{classDMatrix}{DMatrix} object with a vector starting from a given value, with given increments and ending in a given value. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ad79d00fc58e2584963625ecf46ccabee}{colon} (int i1, int increment, int i2)
\begin{DoxyCompactList}\small\item\em This function generates \hyperlink{classDMatrix}{DMatrix} object with a vector starting from a given value, with given increments and ending in a given value. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a1cbcbb56a983edaa8e40dba43df831c0}{colon} (int i1, int i2)
\begin{DoxyCompactList}\small\item\em This function generates \hyperlink{classDMatrix}{DMatrix} object with a vector starting from a given value, with unit increments, and ending in a given value. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a1f79ebd6d8952d215f2792a9c19a0064}{colon} (double i1, double i2)
\begin{DoxyCompactList}\small\item\em This function generates \hyperlink{classDMatrix}{DMatrix} object with a vector starting from a given value, with unit increments, and ending in a given value. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a2987194d90eec1f076a329414ac07278}{colon} (void)
\begin{DoxyCompactList}\small\item\em This function generates a special \hyperlink{classDMatrix}{DMatrix} object with one row and one column which is understood by the indexing functions that take a \hyperlink{classDMatrix}{DMatrix} object as an argument to mean \char`\"{}all rows\char`\"{} or \char`\"{}all columns\char`\"{}. \item\end{DoxyCompactList}\item 
int \hyperlink{classDMatrix_ad90390441283c128e0c64ad67b7a7d16}{any} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a 1 if any alement of \hyperlink{classDMatrix}{DMatrix} object that is passed as argument is non-\/zero, otherwise it returns a zero. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aed1822acbc4a807359a836ab57386d07}{mpow} (\hyperlink{classDMatrix}{DMatrix} \&A, int p)
\begin{DoxyCompactList}\small\item\em This function calculates the integer matrix power. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_abf562762c4dfe45f93d14976001bc61e}{operator$\ast$} (double r, const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function multiplies a real number by a matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ada53ba13afcbd8b7e0916c3275839a85}{tra} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns the transpose of a given matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a322373e24822a8633c2ddfd8f7397c11}{inv} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns the inverse of a given square matrix. If the argument is not a square matrix an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a07480acdabc192269bf2fceb56eb2ef4}{pinv} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns the pseudo-\/inverse of a given rectangular matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac33c390deeaf029a44055773fa06bd00}{identity} (long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n})
\begin{DoxyCompactList}\small\item\em This function returns the identity matrix with a given number of rows and columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ab54dc58f34aa18e7ff82b21b3533b173}{identity} (long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}, long \hyperlink{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}{m})
\begin{DoxyCompactList}\small\item\em This function returns a truncated identity matrix with specified numbers of rows and columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aafc7c944155ff0404f3201ce8b764bea}{eye} (long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n})
\begin{DoxyCompactList}\small\item\em This function returns the identity matrix with a given number of rows and columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aee7a643a65d88ae71a19462563fb9805}{eye} (long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}, long \hyperlink{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}{m})
\begin{DoxyCompactList}\small\item\em This function returns a truncated identity matrix with specified numbers of rows and columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a2150db6f40794cd7741043bcd593d2ce}{zeros} (long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}, long \hyperlink{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}{m})
\begin{DoxyCompactList}\small\item\em This function returns a matrix full of zeros with specified numbers of rows and columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ad90074f7636d5a5a80de596f210b398c}{ones} (long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}, long \hyperlink{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}{m})
\begin{DoxyCompactList}\small\item\em This function returns a matrix full of ones with specified numbers of rows and columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a0cbd806dab65e5458cb5ad832615c506}{expm} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns the exponential matrix of a given square matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ad7d82c1616fcc97e403e50a5066ec851}{sin} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a matrix with the sine of each element of the input matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aa9e07c7b8674a182891bfaf4699906b9}{cos} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a matrix with the cosine of each element of the input matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a60601de2de5f8d857668cca1cea050e5}{tan} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a matrix with the tangent of each element of the input matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a16013e5264442d52b6d98a4a49fee29f}{exp} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a matrix with the natural exponential of each element of the input matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a6b8bfbf386b29e7333e14e4e6d894608}{sinh} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a matrix with the hyperbolic sine of each element of the input matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a567d9f47845cd22715ad3d44e4644b40}{cosh} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a matrix with the hyperbolic cosine of each element of the input matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a524a9c2858469d68aac6a342eac2198a}{tanh} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a matrix with the hyperbolic tangent of each element of the input matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a75ca121105b6022b5cff058be162f209}{log} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a matrix with the natural logarithm of each element of the input matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a417b7d2c566648bf891e5da105ba4233}{diag} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em if A is a matrix this function extracts a column vector with the diagonal values of A. If A is a vector this function returns a matrix having the elements of A in the diagonal \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a36fc8f1174ba00e793bd88142dc11b9f}{TProduct} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function returns the product of the first matrix transposed times the second matrix. The number of rows of both matrices must be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ad77d1a08b972e1cbba7bb60b7ea20bf1}{ProductT} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function returns the product of the first matrix times the second matrix transposed. The number of columns of both matrices must be the same, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_acf0028536903ebb3dc83f1a83b20165c}{TProductT} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function returns the product of the first matrix transposed times the second matrix transposed. The number of rows of the first matrix must be the same as the number of columns of the second matrix, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a4d51f780b4a609cd73c6c6b9b2ff1884}{Product} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function calculates the product of two matrices. The number of columns of the first matrix must be the same as the number of rows of the second matrix, otherwise an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aebb97348d6f64a5a77e6b0a5bcfa3afb}{LUSolve} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&b)
\begin{DoxyCompactList}\small\item\em Solves the system of equations $ A x = b $ using LU factorisation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ad9133e1f6215a490287e1f0b262c5212}{LUFSolve} (const \hyperlink{classDMatrix}{DMatrix} \&ALU, const \hyperlink{classDMatrix}{DMatrix} \&b)
\begin{DoxyCompactList}\small\item\em Solves the system of equations $ A x = b $ using LU factorisation using a previously found LU factors. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a0167e219388b005d7b41ea3403191fd3}{CholSolve} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&b)
\begin{DoxyCompactList}\small\item\em Solves the system of equations $ A x = b $ using Cholesky factorisation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ae5b99d9b1b937f38054ac8d16237b1c2}{CholFSolve} (const \hyperlink{classDMatrix}{DMatrix} \&Achol, const \hyperlink{classDMatrix}{DMatrix} \&b)
\begin{DoxyCompactList}\small\item\em Solves the system of equations $ A x = b $ using Cholesky factorisation. The function uses a previously found Cholesky factorisation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a1266502a32517e157a8a56a312e13b54}{Chol} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em Returns the Cholesky factorisation of a matrix A, which must be a positive definite symmetric matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_af65da2b06dfaa39404003f6a7d09121b}{CholeskyRoot} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em Returns the Cholesky root R of a given matrix A, such that A=R'R. A must be a positive definite symmetric matrix. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a3b4d3e101ff20bd05a1908437481bef0}{QRSolve} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&b)
\begin{DoxyCompactList}\small\item\em Solves the system of equations $ A x = b $ using QR factorisation. The number of rows of matrix A must be greater or equal than the number of columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a3a0e406e05efdd9374cc918645053b27}{QRFSolve} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&b)
\begin{DoxyCompactList}\small\item\em Solves the system of equations $ A x = b $ using QR factorisation. The function uses a previously found QR factorisation. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a31d884a31b9ef5b534de344af01e2a38}{QR} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em Returns the QR factorisation of a matrix A. The number of rows of matrix A must be greater or equal than the number of columns. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aba0583d31407f78cfe1176d74d03fa59}{LSMNSolve} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function solves overdetermined or underdetermined real linear systems $ A x = B $ using a QR or LQ factorization of A. It is assumed that matrix A has full rank. The function uses the LAPACK routine dgels. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a1ccd9a0ef8a37d739b31e85f84c2743c}{LQ} (const \hyperlink{classDMatrix}{DMatrix} \&A, \hyperlink{classDMatrix}{DMatrix} $\ast$Q)
\begin{DoxyCompactList}\small\item\em Returns the LQ factorisation of a matrix A. The function uses the LAPACK routine dgelqf\_\-(). \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a71dd04fdd14b319042752e184ded3393}{LU} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em Returns the LU factorisation of a matrix A. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_afb39cb034e5bef5e4e416a22d53afb56}{SVD} (const \hyperlink{classDMatrix}{DMatrix} \&A, \hyperlink{classDMatrix}{DMatrix} $\ast$U=NULL, \hyperlink{classDMatrix}{DMatrix} $\ast$V=NULL)
\begin{DoxyCompactList}\small\item\em Returns the singular value decomposition of a matrix $ A = U' diag(s) V $, where vector s contains the singular values of A. The function uses the LAPACK routine dgesvd\_\-(). \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ad80782cbeec0075aeaa43fc2e2264cc0}{orth} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns Q, the orthonormal basis for the range of a matrix A, such that $ Q Q' = I $. The number of columns of Q is the rank of A. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a038aceaf8588f3f7743562f598cab15d}{null} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns Z, the orthonormal basis for the null space of a matrix A, such that $ Z Z' = I $ and $ A Z=0 $. The number of columns of Z is the nullity of A. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a13a156103ead07b546c81e6bdd366280}{SVDSolve} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function uses the LAPACK routine dgelss\_\-() to compute the minimum norm solution to a real linear least squares problem: Minimize $ || B - A x ||_2 $ using the singular value decomposition (SVD) of A. A is a rectangular matrix which may be rank-\/deficient. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a2dfbc15150a97456fefdd9d23b1e0932}{schur} (const \hyperlink{classDMatrix}{DMatrix} \&A, \hyperlink{classDMatrix}{DMatrix} $\ast$U=NULL)
\begin{DoxyCompactList}\small\item\em This function computes and returns the Schur decomposition of a matrix A, such that $ A=Q'U Q $, where U is an upper triangular matrix and Q is a unitary matrix. This function uses the LAPACK routine dgees\_\-() \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a160797dd45b601c20b26ad4c189fe8f2}{eig} (const \hyperlink{classDMatrix}{DMatrix} \&A, \hyperlink{classDMatrix}{DMatrix} $\ast$V=NULL)
\begin{DoxyCompactList}\small\item\em This function computes the eigenvalues and (optionally) the eigenvectors of a matrix A. This function uses the LAPACK routines dsyev\_\-() and dgeev\_\-. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_aafa519c3dd4bd2b69731ef2fef01a371}{enorm} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function computes and return the Euclidean norm of a matrix A, which is the square root of the sum of its squared elements. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a5169a4190b500841d156828863e414c8}{norm} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function computes 2-\/norm of matrix A, which is computed as the maximum singular value of A. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_afc6bf998f40686caf55730b53cea7150}{InfNorm} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function computes infinity norm of matrix A, which is computed as the maximum absolute value row sum. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a650d19963c7ca65fe5e8f58c08fc3e55}{Fnorm} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function computes Frobenius norm of matrix A. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a8de28f4be67d64533552e166b44ea128}{Abs} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function computes and returns the element-\/wise absolute value of matrix A. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a734ba2f493c1e69b72dfaf09cfdc1224}{Max} (const \hyperlink{classDMatrix}{DMatrix} \&A, int $\ast$rindx=NULL, int $\ast$cindx=NULL)
\begin{DoxyCompactList}\small\item\em This function finds and returns the element of matrix A with maximum value. It also returns the indices of such element. If more than one element has the same maximum value, the indices of the first element found when searching column by column is returned. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a6bd64bff4bf5dea949448371d9e34c14}{MaxAbs} (const \hyperlink{classDMatrix}{DMatrix} \&A, int $\ast$rindx=NULL, int $\ast$cindx=NULL)
\begin{DoxyCompactList}\small\item\em This function finds and returns the element of matrix A with maximum absolute value. It also returns the indices of such element. If more than one element has the same maximum absolute value, the indices of the first element found when searching column by column is returned. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a6168ace6eec6c2c1724638a1e4c1059c}{Min} (const \hyperlink{classDMatrix}{DMatrix} \&A, int $\ast$rindx=NULL, int $\ast$cindx=NULL)
\begin{DoxyCompactList}\small\item\em This function finds and returns the element of matrix A with minimum value. It also returns the indices of such element. If more than one element has the same minimum value, the indices of the first element found when searching column by column is returned. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a8a3779432dbf1db00faf44079f9a4129}{MinAbs} (const \hyperlink{classDMatrix}{DMatrix} \&A, int $\ast$rindx=NULL, int $\ast$cindx=NULL)
\begin{DoxyCompactList}\small\item\em This function finds and returns the element of matrix A with minimum absolute value. It also returns the indices of such element. If more than one element has the same minimum absolute value, the indices of the first element found when searching column by column is returned. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_ad77fbdfed1b98748e430e4efc2c91856}{sort} (\hyperlink{classDMatrix}{DMatrix} \&x, int indx\mbox{[}$\,$\mbox{]}=NULL)
\begin{DoxyCompactList}\small\item\em This function sorts the input vector x in ascending order. Optionally, it also returns an integer array of sorted indices. If the input object is not a vector, then an error is thrown. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a6b5be996dbe79c22b1a6d616644a1b73}{sort} (\hyperlink{classDMatrix}{DMatrix} \&x, \hyperlink{classDMatrix}{DMatrix} \&indx)
\begin{DoxyCompactList}\small\item\em This function sorts the input vector x in ascending order. It also returns a \hyperlink{classDMatrix}{DMatrix} object with the sorted indices. If the input object is not a vector, then an error is thrown. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a28b13c78f679925c43ba7743e4def95e}{dotProduct} (const \hyperlink{classDMatrix}{DMatrix} \&x, const \hyperlink{classDMatrix}{DMatrix} \&y)
\begin{DoxyCompactList}\small\item\em This function computes the dot product of two vectors. If any of the input arguments does not contain a vector, or if the vector lengths are not equal, an error is thrown. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_ae80c19e8c19de710f5790698e9568756}{dot} (const \hyperlink{classDMatrix}{DMatrix} \&x, const \hyperlink{classDMatrix}{DMatrix} \&y)
\begin{DoxyCompactList}\small\item\em This function computes the dot product of two vectors. If any of the input arguments does not contain a vector, or if the vector lengths are not equal, an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a824f640d88220c84f5b31d9ed191c8ba}{crossProduct} (const \hyperlink{classDMatrix}{DMatrix} \&x, const \hyperlink{classDMatrix}{DMatrix} \&y)
\begin{DoxyCompactList}\small\item\em This function computes the cross product of two vectors. If any of the input arguments does not contain a vector, or if the length of any of the vectors is not 3, an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aaf0cb02dcd852ce56ccb39d550fa7c0a}{cross} (const \hyperlink{classDMatrix}{DMatrix} \&x, const \hyperlink{classDMatrix}{DMatrix} \&y)
\begin{DoxyCompactList}\small\item\em This function computes the cross product of two vectors. If any of the input arguments does not contain a vector, or if the length of any of the vectors is not 3, an error is thrown. \item\end{DoxyCompactList}\item 
int \hyperlink{classDMatrix_ad31c97e930c0fdc797ecd165f251fc27}{isSymmetric} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function checks if the input matrix is symmetric. If the input matrix is not square, an error is thrown. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a474926f74756b827c79b7127a84a4bb6}{cond} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function calculates the 2-\/norm condition number of a matrix, which is the ratio of the maximum singular value to the minimum singular value of the matrix. A large condition number indicates a nearly singular matrix. If the input matrix is not square, an error is thrown. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a5421e6760accac0eefb83d4a604e0612}{rcond} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function estimates the 1-\/norm reciprocal condition number of a matrix. The function uses the LAPACK function dgecon. if A is well conditioned, then rcond(A) is near 1. If A is badly conditioned, then rcond(A) is close to the machine numerical precision (very small). If the input matrix is not square, an error is thrown. \item\end{DoxyCompactList}\item 
int \hyperlink{classDMatrix_a5379bc44e75307fc4f0242ef196ca2c8}{rank} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns an estimate of the rank of a matrix, which is the number of linearly independent rows or columns. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_aafe913bbf754d4c204e4d09033de4ff5}{det} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns the determinant of a square matrix. If the input matrix is not square, an error is thrown. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a25e61176fea3c03f41f8a4524a3a08b0}{trace} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns the trace of a square matrix. If the input matrix is not square, an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a210dc48c90f3be6b71e35784b3625633}{mean} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a row vector with the mean values of the columns of matrix A. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a7c163993971bbf77eb42200e73061eee}{Std} (const \hyperlink{classDMatrix}{DMatrix} \&A, int ntype=0)
\begin{DoxyCompactList}\small\item\em This function returns a row vector with the standard deviation of each column of matrix A. If ntype is 0 (default) the result is normalised with (n-\/1), where n is the number of rows of A. Otherwise, the result is normalised with n. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a261380c58f5a12770bdecf4c0d57eddb}{cov} (const \hyperlink{classDMatrix}{DMatrix} \&A, int ntype=0)
\begin{DoxyCompactList}\small\item\em Computes the covariance matrix of a data matrix where the N rows correspond to samples and the M columns are variables. The result is returned as an M x M matrix. If ntype=0 (default) then the result is normalised with N-\/1. Otherwise, if ntype=1, the result is normalised with N. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ac4da4357ee63d240053aebfc8d687784}{cov} (\hyperlink{classDMatrix}{DMatrix} \&X, \hyperlink{classDMatrix}{DMatrix} \&Y, int ntype=0)
\begin{DoxyCompactList}\small\item\em Computes the covariance matrix of two vectors X and Y of dimension N. The result is returned as an 1 x 1 \hyperlink{classDMatrix}{DMatrix} object. If ntype=0 (default) then the result is normalised with N-\/1. Otherwise, if ntype=1, the result is normalised with N. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a45de81d6d9403a02c173fadc2ffb369a}{var} (\hyperlink{classDMatrix}{DMatrix} \&A, int ntype=0)
\begin{DoxyCompactList}\small\item\em This function returns a row vector with the variance of each column of matrix A. If ntype is 0 (default) the result is normalised with (n-\/1), where n is the number of rows of A. Otherwise, the result is normalised with n. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a7c0db4e6107794b51335d3c767a9cb55}{sum} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a row vector with the sum of the elements of each column of matrix A. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a6cec987fa2c6fb5fb22aaa07e647adba}{prod} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a row vector with the product of the elements of each column of matrix A. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a4fcfc361ca88cbbf21c89c50eca932d8}{elemProduct} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function computes and returns the element-\/wise product of two matrices of the same dimensions. If the dimensions of the two input matrices are not the same, an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a7d66bf14f6c28485a886ece99589d366}{elemDivision} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function computes and returns the element-\/wise division of two matrices of the same dimensions. If the dimensions of the two input matrices are not the same, an error is thrown. The dimensions of the returned object are the same as the dimensions of the factors. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_adc052c1c9f76c909347b83f662fb5952}{kronProduct} (const \hyperlink{classDMatrix}{DMatrix} \&A, const \hyperlink{classDMatrix}{DMatrix} \&B)
\begin{DoxyCompactList}\small\item\em This function computes and returns the Kronecker product of two matrices. The row (column) dimension of the returned object is the product of the row (column) dimensions of both factors. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a643b82daee87c5738faac272b56e8ea8}{vec} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a column vector made by stacking the columns of a matrix one below the other from left to right. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a5fef948be5e07507f9e0c9cc11e6cd09}{MatrixSign} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions as the input matrix such that each of its elements is 1 is the corresponding value of the input matrix is positive, -\/1 if the corresponding value of the input matrix is negative, and 0 if the corresponding value of the input matrix is 0. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_addd401503db0026290c74a9ae860ba6a}{find} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns a column vector with the linear indices of the non-\/zero elements of the input matrix A. The linear index is 1 for element (1,1) of the input matrix A, and length(A) for the (nrows,ncols) element of the input matrix A. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a299e165ca173181d5efb78a2098f742c}{randu} (long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}, long \hyperlink{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}{m})
\begin{DoxyCompactList}\small\item\em This function returns an nxm matrix where each element is a uniform pseudo-\/random number in the range (0,1). \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a4bc7a80762269f95de50605fc87f0223}{randn} (long \hyperlink{classDMatrix_a6b7668991ff7d01230b3599836a5d682}{n}, long \hyperlink{classDMatrix_a9cb55e3ad06f81025fed1ffbb0ae28bd}{m})
\begin{DoxyCompactList}\small\item\em This function returns an nxm matrix where each element is a Gaussian pseudo-\/random number in the range with zero mean and variance 1. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_aa3d52614c6e5b34caff46a462af5e48c}{linspace} (double X1, double X2, long N)
\begin{DoxyCompactList}\small\item\em This function returns a linearly spaced vector with N points between the values X1 and X2. \item\end{DoxyCompactList}\item 
void \hyperlink{classDMatrix_a6067456d71764a846f24a141e77d00f3}{error\_\-message} (const char $\ast$input\_\-text)
\begin{DoxyCompactList}\small\item\em This function prints an error message and throws an exception to be handled by the \hyperlink{classErrorHandler}{ErrorHandler} class. \item\end{DoxyCompactList}\item 
\hypertarget{classDMatrix_ace51fd7d8435f88c8b2b3bcf64367673}{
void \hyperlink{classDMatrix_ace51fd7d8435f88c8b2b3bcf64367673}{tic} (void)}
\label{classDMatrix_ace51fd7d8435f88c8b2b3bcf64367673}

\begin{DoxyCompactList}\small\item\em This function, which is to be used in conjunction with function \hyperlink{classDMatrix_a38664cf3d259198ae1e644736aa5e70e}{toc()}, starts counting elapsed CPU time. \item\end{DoxyCompactList}\item 
double \hyperlink{classDMatrix_a38664cf3d259198ae1e644736aa5e70e}{toc} ()
\begin{DoxyCompactList}\small\item\em This function, which is to be used in conjunction with function \hyperlink{classDMatrix_ace51fd7d8435f88c8b2b3bcf64367673}{tic()}, stops counting CPU time, and it prints and returns the elapsed time in seconds since the function \hyperlink{classDMatrix_ace51fd7d8435f88c8b2b3bcf64367673}{tic()} was called. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ae2a60a1294685079c39ea189bacdb4d2}{Sqrt} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function computes the square root of each element of the input matrix A, and it returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions as the input matrix. If any element of the input matrix is negative, an error is thrown. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_a8483633c05422fa0beb4fcad7276152f}{triu} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function extracts and return the triangular upper part of the input matrix A. The returned object has the same dimensions as the input object. \item\end{DoxyCompactList}\item 
\hyperlink{classDMatrix}{DMatrix} \& \hyperlink{classDMatrix_ae626fae47c554940c8384933c6ca1e9f}{reshape} (\hyperlink{classDMatrix}{DMatrix} \&A, long N, long M)
\begin{DoxyCompactList}\small\item\em This function returns the N-\/by-\/M matrix whose elements are taken columnwise from the input matrix A. An error is thrown if A does not have N$\ast$M elements. \item\end{DoxyCompactList}\item 
long \hyperlink{classDMatrix_a416133f8c3a457e0997f7f387697be62}{length} (const \hyperlink{classDMatrix}{DMatrix} \&A)
\begin{DoxyCompactList}\small\item\em This function returns the number of elements of a matrix A. \item\end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\hyperlink{classDMatrix}{DMatrix} class. A C++ class for dense and real matrix and vector computations with interfaces to a number of LAPACK functions 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classDMatrix_ae3911763fdae4b6f4d41772031c9a2da}{
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\subsubsection[{DMatrix}]{\setlength{\rightskip}{0pt plus 5cm}DMatrix::DMatrix (
\begin{DoxyParamCaption}
\item[{long}]{Initn, }
\item[{long}]{Initm}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_ae3911763fdae4b6f4d41772031c9a2da}


Constructor with dimensions. Creates a matrix with allocated storage given specified numbers of rows and columns. 


\begin{DoxyParams}{Parameters}
{\em Initn,:} & number of rows \\
\hline
{\em Initm,:} & number of columns \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_a4751cd36f1eb0b65f4c25eced0142192}{
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\subsubsection[{DMatrix}]{\setlength{\rightskip}{0pt plus 5cm}DMatrix::DMatrix (
\begin{DoxyParamCaption}
\item[{long}]{vDim, }
\item[{double $\ast$}]{v, }
\item[{long}]{Initn, }
\item[{long}]{Initm}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a4751cd36f1eb0b65f4c25eced0142192}


Constructor with dimensions using pre-\/allocated storage. 


\begin{DoxyParams}{Parameters}
{\em vDim,:} & Allocated length of array v \\
\hline
{\em v,:} & double array to be used as storage by the \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em Initn,:} & number of rows \\
\hline
{\em Initm,:} & number of columns \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_a7e8d467c27e1dc57c2cdae0c28efea21}{
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\subsubsection[{DMatrix}]{\setlength{\rightskip}{0pt plus 5cm}DMatrix::DMatrix (
\begin{DoxyParamCaption}
\item[{long}]{Initn}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a7e8d467c27e1dc57c2cdae0c28efea21}


Constructor with a single dimension, creates a column vector. 


\begin{DoxyParams}{Parameters}
{\em Initn,:} & number of rows \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_a823b4bf5f2957ea5c2d9339292237234}{
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\subsubsection[{DMatrix}]{\setlength{\rightskip}{0pt plus 5cm}DMatrix::DMatrix (
\begin{DoxyParamCaption}
\item[{long}]{Initn, }
\item[{long}]{Initm, }
\item[{double}]{a11, }
\item[{}]{...}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a823b4bf5f2957ea5c2d9339292237234}


Constructor using a variable list of element values. 


\begin{DoxyParams}{Parameters}
{\em Initn,:} & number of rows \\
\hline
{\em Initm,:} & number of columns \\
\hline
{\em a11,:} & first element of list doubles, values are entered column by column \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_af8ff7b8c264b0390e20c2c9c58a03b64}{
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\index{DMatrix@{DMatrix}!DMatrix@{DMatrix}}
\subsubsection[{DMatrix}]{\setlength{\rightskip}{0pt plus 5cm}DMatrix::DMatrix (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_af8ff7b8c264b0390e20c2c9c58a03b64}


Copy constructor. Creates a new \hyperlink{classDMatrix}{DMatrix} object with the same dimensions and element values as a given \hyperlink{classDMatrix}{DMatrix} object. 


\begin{DoxyParams}{Parameters}
{\em A,:} & \hyperlink{classDMatrix}{DMatrix} object to be copied \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classDMatrix_ac643c444a18419885b5ac5a2f8d003be}{
\index{DMatrix@{DMatrix}!Allocate@{Allocate}}
\index{Allocate@{Allocate}!DMatrix@{DMatrix}}
\subsubsection[{Allocate}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::Allocate (
\begin{DoxyParamCaption}
\item[{long}]{size}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}protected\mbox{]}}}}
\label{classDMatrix_ac643c444a18419885b5ac5a2f8d003be}


Allocate memory to store matrix elements. 


\begin{DoxyParams}{Parameters}
{\em size} & number of double elements to allocate \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_a077cd396523652629a258cb11f469886}{DeAllocate()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_aadec35682639717d9bc698cfee3953ad}{
\index{DMatrix@{DMatrix}!AllocateAuxArr@{AllocateAuxArr}}
\index{AllocateAuxArr@{AllocateAuxArr}!DMatrix@{DMatrix}}
\subsubsection[{AllocateAuxArr}]{\setlength{\rightskip}{0pt plus 5cm}static void DMatrix::AllocateAuxArr (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classDMatrix_aadec35682639717d9bc698cfee3953ad}


Allocates the array of auxiliary (temporary) objects used by the class. 

Allocates a \hyperlink{classDMatrix}{DMatrix} array of size N\_\-TEMP\_\-OBJECTS. Each element is allocated a storage of size D\_\-TEMP\_\-OBJECTS. These two macros are given default values but may be changed by the user at compilation time. The purpose of the array of temporary objects is to to store the intermediate objects resulting from single lines of code that call various operators and functions returning \hyperlink{classDMatrix}{DMatrix} objects. A simple example is as follows. Consider the C++ statement D= A$\ast$B + C; where A,B C and D are \hyperlink{classDMatrix}{DMatrix} objects. This statement involves two temporary objects: one to store the result of A$\ast$B, and another one to store the result of (A$\ast$B)+C; \begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_ab8c6ade7a8a3cfaae690572887575fdc}{
\index{DMatrix@{DMatrix}!assign@{assign}}
\index{assign@{assign}!DMatrix@{DMatrix}}
\subsubsection[{assign}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::assign (
\begin{DoxyParamCaption}
\item[{long}]{rows, }
\item[{long}]{columns, }
\item[{double}]{a11, }
\item[{}]{...}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_ab8c6ade7a8a3cfaae690572887575fdc}


Assigns values to the elements of an existing \hyperlink{classDMatrix}{DMatrix} object using a variable list of values. Resizes the matrix if necessary. 


\begin{DoxyParams}{Parameters}
{\em rows,:} & number of rows \\
\hline
{\em columns,:} & number of columns \\
\hline
{\em a11,:} & first element of the list of double arguments. \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_a9630eee5b92eb0b651789204f91b55e7}{
\index{DMatrix@{DMatrix}!AssignmentToColonReference@{AssignmentToColonReference}}
\index{AssignmentToColonReference@{AssignmentToColonReference}!DMatrix@{DMatrix}}
\subsubsection[{AssignmentToColonReference}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::AssignmentToColonReference (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}protected\mbox{]}}}}
\label{classDMatrix_a9630eee5b92eb0b651789204f91b55e7}


Assigns a matrix to the values pointed to by a colon reference matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
reference to \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac4080d0de15b606eac2a3e0ab34a8e13}{
\index{DMatrix@{DMatrix}!AssignmentToColonReference@{AssignmentToColonReference}}
\index{AssignmentToColonReference@{AssignmentToColonReference}!DMatrix@{DMatrix}}
\subsubsection[{AssignmentToColonReference}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::AssignmentToColonReference (
\begin{DoxyParamCaption}
\item[{double}]{arg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}protected\mbox{]}}}}
\label{classDMatrix_ac4080d0de15b606eac2a3e0ab34a8e13}


Assigns a double value to each value pointed to by a colon reference matrix. 


\begin{DoxyParams}{Parameters}
{\em arg} & is a double value to be assigned. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
reference to \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a54df2f008095aa1ec06ecebce8073c38}{
\index{DMatrix@{DMatrix}!colMult@{colMult}}
\index{colMult@{colMult}!DMatrix@{DMatrix}}
\subsubsection[{colMult}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::colMult (
\begin{DoxyParamCaption}
\item[{long}]{c, }
\item[{double}]{x}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a54df2f008095aa1ec06ecebce8073c38}


Multiples the elements of a specified column of a matrix by a constant scalar value. 


\begin{DoxyParams}{Parameters}
{\em c,:} & index to the column that is to be changed \\
\hline
{\em x,:} & scalar value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_add29fc33eedb04efe3950fcc4c2a31dd}{
\index{DMatrix@{DMatrix}!Column@{Column}}
\index{Column@{Column}!DMatrix@{DMatrix}}
\subsubsection[{Column}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::Column (
\begin{DoxyParamCaption}
\item[{long}]{icol}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_add29fc33eedb04efe3950fcc4c2a31dd}


Returns a \hyperlink{classDMatrix}{DMatrix} object containing a speficied column of the calling object. 


\begin{DoxyParams}{Parameters}
{\em icol,:} & column index (starting from 1) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{classDMatrix}{DMatrix} object with the specified column 
\end{DoxyReturn}
\hypertarget{classDMatrix_a8935b0337db48a93dd91cb87c698b291}{
\index{DMatrix@{DMatrix}!compMat@{compMat}}
\index{compMat@{compMat}!DMatrix@{DMatrix}}
\subsubsection[{compMat}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::compMat (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{m2, }
\item[{char}]{op}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}protected\mbox{]}}}}
\label{classDMatrix_a8935b0337db48a93dd91cb87c698b291}


Elementwise comparison of matrix elements. 


\begin{DoxyParams}{Parameters}
{\em m2} & \hyperlink{classDMatrix}{DMatrix} object to be compared with the calling object. \\
\hline
{\em op} & (char) indicates type of operator. Use 1 for $>$, 2 for $>$=,. 3 for $<$, 4 for $<$=, 5 for ==, 6 for != comparisons \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
A reference to a \hyperlink{classDMatrix}{DMatrix} object such that its elements are 1 if the comparison is true, 0 otherwise. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a077cd396523652629a258cb11f469886}{
\index{DMatrix@{DMatrix}!DeAllocate@{DeAllocate}}
\index{DeAllocate@{DeAllocate}!DMatrix@{DMatrix}}
\subsubsection[{DeAllocate}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::DeAllocate (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}protected\mbox{]}}}}
\label{classDMatrix_a077cd396523652629a258cb11f469886}


De-\/allocate memory previously allocated with \hyperlink{classDMatrix_ac643c444a18419885b5ac5a2f8d003be}{DMatrix::Allocate()}. 

\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_ac643c444a18419885b5ac5a2f8d003be}{Allocate()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_a6389bc3790f8b71dd59a8f2bd659fc27}{
\index{DMatrix@{DMatrix}!DeAllocateAuxArr@{DeAllocateAuxArr}}
\index{DeAllocateAuxArr@{DeAllocateAuxArr}!DMatrix@{DMatrix}}
\subsubsection[{DeAllocateAuxArr}]{\setlength{\rightskip}{0pt plus 5cm}static void DMatrix::DeAllocateAuxArr (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classDMatrix_a6389bc3790f8b71dd59a8f2bd659fc27}


De-\/allocates the array of auxiliary (temporary) objects previously allocated by \hyperlink{classDMatrix_aadec35682639717d9bc698cfee3953ad}{AllocateAuxArr()} 

\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_ae18275d9d832807ea53e4ccb93e461f0}{
\index{DMatrix@{DMatrix}!diag@{diag}}
\index{diag@{diag}!DMatrix@{DMatrix}}
\subsubsection[{diag}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::diag (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{dd}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_ae18275d9d832807ea53e4ccb93e461f0}


Assigns values to the diagonal elements of a matrix, while all off-\/diagonal elements are set to zero. 

The dimensions of dd should be consistant with the dimensions of the calling object 
\begin{DoxyParams}{Parameters}
{\em dd,:} & reference to constant \hyperlink{classDMatrix}{DMatrix} object which should contain a vector with the desired diagonal elements \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad07f4bea1e8e45647eb1514c1cb745be}{
\index{DMatrix@{DMatrix}!elem@{elem}}
\index{elem@{elem}!DMatrix@{DMatrix}}
\subsubsection[{elem}]{\setlength{\rightskip}{0pt plus 5cm}double DMatrix::elem (
\begin{DoxyParamCaption}
\item[{long}]{i, }
\item[{long}]{j}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_ad07f4bea1e8e45647eb1514c1cb745be}


Returns the value of a specified element of a matrix. 


\begin{DoxyParams}{Parameters}
{\em i,:} & row index (starting from 1) \\
\hline
{\em j,:} & column index (starting from 1) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
double value 
\end{DoxyReturn}
\hypertarget{classDMatrix_afbeef8ed62a91eef48e8664f6a9accd0}{
\index{DMatrix@{DMatrix}!elem@{elem}}
\index{elem@{elem}!DMatrix@{DMatrix}}
\subsubsection[{elem}]{\setlength{\rightskip}{0pt plus 5cm}double\& DMatrix::elem (
\begin{DoxyParamCaption}
\item[{long}]{i, }
\item[{long}]{j}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_afbeef8ed62a91eef48e8664f6a9accd0}


Returns a reference to the specified element of a matrix. 


\begin{DoxyParams}{Parameters}
{\em i,:} & row index (starting from 1) \\
\hline
{\em j,:} & column index (starting from 1) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
double reference 
\end{DoxyReturn}
\hypertarget{classDMatrix_a874f1e4a2796127f8efc9dedfe901603}{
\index{DMatrix@{DMatrix}!element@{element}}
\index{element@{element}!DMatrix@{DMatrix}}
\subsubsection[{element}]{\setlength{\rightskip}{0pt plus 5cm}double DMatrix::element (
\begin{DoxyParamCaption}
\item[{long}]{i, }
\item[{long}]{j}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a874f1e4a2796127f8efc9dedfe901603}


Returns the value of a specified element of a matrix. 


\begin{DoxyParams}{Parameters}
{\em i,:} & row index (starting from 1) \\
\hline
{\em j,:} & column index (starting from 1) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
double value 
\end{DoxyReturn}
\hypertarget{classDMatrix_abebb69fbb1f71d2b49f575153bb36fee}{
\index{DMatrix@{DMatrix}!FillWithZeros@{FillWithZeros}}
\index{FillWithZeros@{FillWithZeros}!DMatrix@{DMatrix}}
\subsubsection[{FillWithZeros}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::FillWithZeros (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_abebb69fbb1f71d2b49f575153bb36fee}


Assigns a zero value to each element of a matrix. 

\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a8b15c0468cccb85d5102e4e1138e8f44}{
\index{DMatrix@{DMatrix}!find@{find}}
\index{find@{find}!DMatrix@{DMatrix}}
\subsubsection[{find}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::find (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} \&}]{I, }
\item[{{\bf DMatrix} \&}]{J}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a8b15c0468cccb85d5102e4e1138e8f44}


Finds non-\/zero values of a matrix. 


\begin{DoxyParams}{Parameters}
{\em I,:} & \hyperlink{classDMatrix}{DMatrix} object with the row index of each non-\/zero element \\
\hline
{\em J,:} & \hyperlink{classDMatrix}{DMatrix} object with the column index of each non-\/zero element \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{classDMatrix}{DMatrix} object with the same dimensions as the calling object, and with elements which are 0 if the corresponding element of the calling object is 0, 1 otherwise. 
\end{DoxyReturn}
\hypertarget{classDMatrix_abf563652a938b64d2074d734584b738c}{
\index{DMatrix@{DMatrix}!find@{find}}
\index{find@{find}!DMatrix@{DMatrix}}
\subsubsection[{find}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::find (
\begin{DoxyParamCaption}
\item[{int $\ast$}]{I, }
\item[{int $\ast$}]{J}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_abf563652a938b64d2074d734584b738c}


Finds non-\/zero values of a matrix. 


\begin{DoxyParams}{Parameters}
{\em I,:} & C++ double array with the row index of each non-\/zero element \\
\hline
{\em J,:} & C++ double array with the column index of each non-\/zero element \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{classDMatrix}{DMatrix} object with the same dimensions as the calling object, and with elements which are 0 if the corresponding element of the calling object is 0, 1 otherwise. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a3470a954caccffa3bec8b134c2e5f179}{
\index{DMatrix@{DMatrix}!Fprint@{Fprint}}
\index{Fprint@{Fprint}!DMatrix@{DMatrix}}
\subsubsection[{Fprint}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::Fprint (
\begin{DoxyParamCaption}
\item[{FILE $\ast$}]{filex}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a3470a954caccffa3bec8b134c2e5f179}


Prints the elements of a matrix elements matrix to a file. 


\begin{DoxyParams}{Parameters}
{\em filex} & is a pointer to a file already opened using \char`\"{}fopen()\char`\"{}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a48e4e74d3cd7affb6af7d1d0beaca129}{
\index{DMatrix@{DMatrix}!geta@{geta}}
\index{geta@{geta}!DMatrix@{DMatrix}}
\subsubsection[{geta}]{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ DMatrix::geta (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a48e4e74d3cd7affb6af7d1d0beaca129}


Gets a pointer to the array where the elements of the matrix are stored. 

\begin{DoxyReturn}{Returns}
double pointer 
\end{DoxyReturn}
\hypertarget{classDMatrix_a34b0f1e03bfc35e7e6ac298d21ca78c7}{
\index{DMatrix@{DMatrix}!getatype@{getatype}}
\index{getatype@{getatype}!DMatrix@{DMatrix}}
\subsubsection[{getatype}]{\setlength{\rightskip}{0pt plus 5cm}int DMatrix::getatype (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a34b0f1e03bfc35e7e6ac298d21ca78c7}


Gets the type of element storage of a matrix. 

\begin{DoxyReturn}{Returns}
int value: 0 if the array is allocated, 1 if the storage is done using a previously declared array of doubles. 
\end{DoxyReturn}
\hypertarget{classDMatrix_adfa26d6b647b74af5f592d51bf70e8f4}{
\index{DMatrix@{DMatrix}!GetAuxPr@{GetAuxPr}}
\index{GetAuxPr@{GetAuxPr}!DMatrix@{DMatrix}}
\subsubsection[{GetAuxPr}]{\setlength{\rightskip}{0pt plus 5cm}static {\bf DMatrix}$\ast$$\ast$ DMatrix::GetAuxPr (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, static\mbox{]}}}}
\label{classDMatrix_adfa26d6b647b74af5f592d51bf70e8f4}


Gets a pointer to the array of auxiliary objects. 

\begin{DoxyReturn}{Returns}
DMatrix$\ast$$\ast$ pointer 
\end{DoxyReturn}
\hypertarget{classDMatrix_a2b8280816c4f3508d522462fd09732cf}{
\index{DMatrix@{DMatrix}!GetConstPr@{GetConstPr}}
\index{GetConstPr@{GetConstPr}!DMatrix@{DMatrix}}
\subsubsection[{GetConstPr}]{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ DMatrix::GetConstPr (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a2b8280816c4f3508d522462fd09732cf}


Gets a pointer to the array where the elements of the matrix are stored (for const objects) 

\begin{DoxyReturn}{Returns}
double pointer 
\end{DoxyReturn}
\hypertarget{classDMatrix_a1954420b4966f38c5ed7e386648f087b}{
\index{DMatrix@{DMatrix}!getm@{getm}}
\index{getm@{getm}!DMatrix@{DMatrix}}
\subsubsection[{getm}]{\setlength{\rightskip}{0pt plus 5cm}long DMatrix::getm (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a1954420b4966f38c5ed7e386648f087b}


Gets the number of columns from the calling object. 

\begin{DoxyReturn}{Returns}
long value with the number of columns 
\end{DoxyReturn}
\hypertarget{classDMatrix_a61fb36c4c0b342f7aabc0c709e761c26}{
\index{DMatrix@{DMatrix}!getm@{getm}}
\index{getm@{getm}!DMatrix@{DMatrix}}
\subsubsection[{getm}]{\setlength{\rightskip}{0pt plus 5cm}long DMatrix::getm (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a61fb36c4c0b342f7aabc0c709e761c26}


Gets the number of columns from the calling object. 

\begin{DoxyReturn}{Returns}
long value with the number of columns 
\end{DoxyReturn}
\hypertarget{classDMatrix_a8617eafafa13e38ba6dd7d0265b1c9a3}{
\index{DMatrix@{DMatrix}!GetMType@{GetMType}}
\index{GetMType@{GetMType}!DMatrix@{DMatrix}}
\subsubsection[{GetMType}]{\setlength{\rightskip}{0pt plus 5cm}int DMatrix::GetMType (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, protected\mbox{]}}}}
\label{classDMatrix_a8617eafafa13e38ba6dd7d0265b1c9a3}


Gets the type of matrix. 

\begin{DoxyReturn}{Returns}
int value 
\end{DoxyReturn}
\hypertarget{classDMatrix_ae9ea1cd2a83a4e84e072b62addd825cc}{
\index{DMatrix@{DMatrix}!getn@{getn}}
\index{getn@{getn}!DMatrix@{DMatrix}}
\subsubsection[{getn}]{\setlength{\rightskip}{0pt plus 5cm}long DMatrix::getn (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_ae9ea1cd2a83a4e84e072b62addd825cc}


Gets the number of rows from the calling object. 

\begin{DoxyReturn}{Returns}
long value with the number of rows. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a569af1f26034f5450d059637c9ea909e}{
\index{DMatrix@{DMatrix}!getn@{getn}}
\index{getn@{getn}!DMatrix@{DMatrix}}
\subsubsection[{getn}]{\setlength{\rightskip}{0pt plus 5cm}long DMatrix::getn (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a569af1f26034f5450d059637c9ea909e}


Gets the number of rows from the calling object. 

\begin{DoxyReturn}{Returns}
long value with the number of rows. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a16ac005120f99416a8e914aa1119eff1}{
\index{DMatrix@{DMatrix}!GetNoCols@{GetNoCols}}
\index{GetNoCols@{GetNoCols}!DMatrix@{DMatrix}}
\subsubsection[{GetNoCols}]{\setlength{\rightskip}{0pt plus 5cm}long DMatrix::GetNoCols (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a16ac005120f99416a8e914aa1119eff1}


Gets the number of columns from the calling object. 

\begin{DoxyReturn}{Returns}
long value with the number of columns 
\end{DoxyReturn}
\hypertarget{classDMatrix_a8b234f10a804f49ccf711051ac022156}{
\index{DMatrix@{DMatrix}!GetNoCols@{GetNoCols}}
\index{GetNoCols@{GetNoCols}!DMatrix@{DMatrix}}
\subsubsection[{GetNoCols}]{\setlength{\rightskip}{0pt plus 5cm}long DMatrix::GetNoCols (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a8b234f10a804f49ccf711051ac022156}


Gets the number of columns from the calling object. 

\begin{DoxyReturn}{Returns}
long value with the number of columns 
\end{DoxyReturn}
\hypertarget{classDMatrix_a45ab6509deee2a3e1a13d27e2b3e929e}{
\index{DMatrix@{DMatrix}!GetNoRows@{GetNoRows}}
\index{GetNoRows@{GetNoRows}!DMatrix@{DMatrix}}
\subsubsection[{GetNoRows}]{\setlength{\rightskip}{0pt plus 5cm}long DMatrix::GetNoRows (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a45ab6509deee2a3e1a13d27e2b3e929e}


Gets the number of rows from the calling object. 

\begin{DoxyReturn}{Returns}
long value with the number of rows. 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac5729ab1d4162789c067ed4928ea86e5}{
\index{DMatrix@{DMatrix}!GetNoRows@{GetNoRows}}
\index{GetNoRows@{GetNoRows}!DMatrix@{DMatrix}}
\subsubsection[{GetNoRows}]{\setlength{\rightskip}{0pt plus 5cm}long DMatrix::GetNoRows (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_ac5729ab1d4162789c067ed4928ea86e5}


Gets the number of rows from the calling object. 

\begin{DoxyReturn}{Returns}
long value with the number of rows. 
\end{DoxyReturn}
\hypertarget{classDMatrix_aeda5a29d08ef2a98344d65ba37fe53b1}{
\index{DMatrix@{DMatrix}!GetPr@{GetPr}}
\index{GetPr@{GetPr}!DMatrix@{DMatrix}}
\subsubsection[{GetPr}]{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ DMatrix::GetPr (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_aeda5a29d08ef2a98344d65ba37fe53b1}


Gets the pointer to the array where the elements of the matrix are stored. 

\begin{DoxyReturn}{Returns}
double pointer 
\end{DoxyReturn}
\hypertarget{classDMatrix_a9bb99d0f897fe9e23b5370e11bf80d3f}{
\index{DMatrix@{DMatrix}!GetReferencedDMatrixPointer@{GetReferencedDMatrixPointer}}
\index{GetReferencedDMatrixPointer@{GetReferencedDMatrixPointer}!DMatrix@{DMatrix}}
\subsubsection[{GetReferencedDMatrixPointer}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}$\ast$ DMatrix::GetReferencedDMatrixPointer (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, protected\mbox{]}}}}
\label{classDMatrix_a9bb99d0f897fe9e23b5370e11bf80d3f}


Gets the value of the referenced matrix pointer. 

\begin{DoxyReturn}{Returns}
pointer to \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a414e84e3c2c91900f44b58a9d09d0acc}{
\index{DMatrix@{DMatrix}!input\_\-matrix@{input\_\-matrix}}
\index{input\_\-matrix@{input\_\-matrix}!DMatrix@{DMatrix}}
\subsubsection[{input\_\-matrix}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::input\_\-matrix (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a414e84e3c2c91900f44b58a9d09d0acc}


Allows the user to enter the elements of a matrix using command line prompts. 

\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a5616c72557eae51c38af63f6684391d0}{
\index{DMatrix@{DMatrix}!isEmpty@{isEmpty}}
\index{isEmpty@{isEmpty}!DMatrix@{DMatrix}}
\subsubsection[{isEmpty}]{\setlength{\rightskip}{0pt plus 5cm}int DMatrix::isEmpty (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a5616c72557eae51c38af63f6684391d0}


Check if a matrix object is empty, if other words this method checks if the calling object has zero elements. 

\begin{DoxyReturn}{Returns}
int value: 0 if calling object is not empty, 1 otherwise 
\end{DoxyReturn}
\hypertarget{classDMatrix_a3c854cc931571f2eba43f374e17ff18d}{
\index{DMatrix@{DMatrix}!isThereError@{isThereError}}
\index{isThereError@{isThereError}!DMatrix@{DMatrix}}
\subsubsection[{isThereError}]{\setlength{\rightskip}{0pt plus 5cm}static int DMatrix::isThereError (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, static\mbox{]}}}}
\label{classDMatrix_a3c854cc931571f2eba43f374e17ff18d}


Checks if the error flag has been raised. If so, a 1 is returned, 0 otherwise. 

\begin{DoxyReturn}{Returns}
int value 
\end{DoxyReturn}
\hypertarget{classDMatrix_a05a0f57ed7ed6cc3d57d9294d48ee4cc}{
\index{DMatrix@{DMatrix}!isVector@{isVector}}
\index{isVector@{isVector}!DMatrix@{DMatrix}}
\subsubsection[{isVector}]{\setlength{\rightskip}{0pt plus 5cm}int DMatrix::isVector (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classDMatrix_a05a0f57ed7ed6cc3d57d9294d48ee4cc}


Check if a matrix object contains a row or column vector. 

\begin{DoxyReturn}{Returns}
int value: 1 if calling object is a vector, 0 otherwise 
\end{DoxyReturn}
\hypertarget{classDMatrix_a26e8a17738092057014b0b72ef99c661}{
\index{DMatrix@{DMatrix}!Load@{Load}}
\index{Load@{Load}!DMatrix@{DMatrix}}
\subsubsection[{Load}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::Load (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{FileName}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a26e8a17738092057014b0b72ef99c661}


Reads the elements of a matrix from a file. 

The calling object should have the appropriate number of rows and columns. 
\begin{DoxyParams}{Parameters}
{\em FileName} & is a string with the file name where the matrix elements are stored. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a0363c3677623145f180fe42d294c6ede}{
\index{DMatrix@{DMatrix}!MemCpyArray@{MemCpyArray}}
\index{MemCpyArray@{MemCpyArray}!DMatrix@{DMatrix}}
\subsubsection[{MemCpyArray}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::MemCpyArray (
\begin{DoxyParamCaption}
\item[{double $\ast$}]{aptr}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a0363c3677623145f180fe42d294c6ede}


Copies values to the elements of a \hyperlink{classDMatrix}{DMatrix} object from an existing array. The number of elements of the \hyperlink{classDMatrix}{DMatrix} object is assumed to be the number of values to be copied. 


\begin{DoxyParams}{Parameters}
{\em aptr,:} & pointer to the start of the array of doubles to be copied. \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_aeb2c289d9a40b0869f2fef29ffd6340e}{
\index{DMatrix@{DMatrix}!mpow@{mpow}}
\index{mpow@{mpow}!DMatrix@{DMatrix}}
\subsubsection[{mpow}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::mpow (
\begin{DoxyParamCaption}
\item[{int}]{p}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_aeb2c289d9a40b0869f2fef29ffd6340e}


Computes and returns the integer power of a matrix. 


\begin{DoxyParams}{Parameters}
{\em p,:} & integer value, starting from 0 \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{classDMatrix}{DMatrix} object with the result of the calculation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a475f14adcb18e617464bd66021fc4ca2}{
\index{DMatrix@{DMatrix}!operator!=@{operator!=}}
\index{operator!=@{operator!=}!DMatrix@{DMatrix}}
\subsubsection[{operator!=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator!= (
\begin{DoxyParamCaption}
\item[{double}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a475f14adcb18e617464bd66021fc4ca2}


Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is different from the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. 


\begin{DoxyParams}{Parameters}
{\em val,:} & right hand side value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a50d36066d7917dee27b67665b91d78a3}{
\index{DMatrix@{DMatrix}!operator!=@{operator!=}}
\index{operator!=@{operator!=}!DMatrix@{DMatrix}}
\subsubsection[{operator!=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator!= (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a50d36066d7917dee27b67665b91d78a3}


Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is different from the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em val,:} & val: right hand side object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_aa26baf81cd578c80fed72d7b6179ad1f}{
\index{DMatrix@{DMatrix}!operator\%@{operator\%}}
\index{operator\%@{operator\%}!DMatrix@{DMatrix}}
\subsubsection[{operator\%}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator\% (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_aa26baf81cd578c80fed72d7b6179ad1f}


Computes the left division of a matrix (left hand side of the operator) by another matrix (right hand side value). This is conceptually equivalent to multiplying the inverse of the left object by the right hand side object but it is computed in a more efficient way. The dimensions of the matrices must be consistent, otherwise an error is returned. The left hand side object must be a square matrix. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & \hyperlink{classDMatrix}{DMatrix} object at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a051fc52a9620318d04dd454d7970d319}{
\index{DMatrix@{DMatrix}!operator\&@{operator\&}}
\index{operator\&@{operator\&}!DMatrix@{DMatrix}}
\subsubsection[{operator\&}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator\& (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix}}]{B}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a051fc52a9620318d04dd454d7970d319}


Elementwise product operator. Returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions of the calling objects and each of its elements is computed as the product of the corresponding elements of the calling object and the right hand side object. The dimensions of the calling objects must be the same, otherwise an error is thrown. Care must be taken when using this operator as the associations do not work in the same way as with the $\ast$ operator. It is highly recommended to use parenthesis every time this operator is used. For example use it as follows: (A\&B). 


\begin{DoxyParams}{Parameters}
{\em B,:} & \hyperlink{classDMatrix}{DMatrix} object at the right hand side of the operator \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a0346b7c7d5952c7dbae995150ee40476}{
\index{DMatrix@{DMatrix}!operator\&\&@{operator\&\&}}
\index{operator\&\&@{operator\&\&}!DMatrix@{DMatrix}}
\subsubsection[{operator\&\&}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator\&\& (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a0346b7c7d5952c7dbae995150ee40476}


Stacks the right hand side matrix below the left hand side matrix. The dimensions number of columns of the matrices involved must be the same, otherwise an error is thrown. The number of rows of the resulting matrix is the addition of the number of rows of both matrices involved. 


\begin{DoxyParams}{Parameters}
{\em B,:} & \hyperlink{classDMatrix}{DMatrix} object at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_aad182b5dbdaa8ec1911904639d5626de}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{RowIndx, }
\item[{long}]{col}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_aad182b5dbdaa8ec1911904639d5626de}


Sub-\/vector extraction and referencing using an array of row indices for a given column. 


\begin{DoxyParams}{Parameters}
{\em RowIndx} & is a \hyperlink{classDMatrix}{DMatrix} array that contains row index values usually generated using the \hyperlink{classDMatrix_a2987194d90eec1f076a329414ac07278}{colon()} function. \\
\hline
{\em col} & is a column index \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a \hyperlink{classDMatrix}{DMatrix} mtype 1 object that maps to the referenced elements of the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_aca1e6c7d7c8859a705bc87674003a194}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{end, }
\item[{long}]{col}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_aca1e6c7d7c8859a705bc87674003a194}


Matrix indexing. Returns the value of the matrix element located at the position indicated by the column index and the last row. Indices start from 1. An error in thrown in case of a range violation. 


\begin{DoxyParams}{Parameters}
{\em end,:} & Character string containing the word \char`\"{}end\char`\"{}. \\
\hline
{\em col,:} & Column index starting from 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
double value of the indexed matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a107a1b256e91c653cd48a863ba063494}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{end}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a107a1b256e91c653cd48a863ba063494}


Access to last linear element. Returns the value of the last linear matrix element, assuming column major storage. 


\begin{DoxyParams}{Parameters}
{\em end,:} & Character string containing the word \char`\"{}end\char`\"{}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
value of the last matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad9815228adc3856c7cdc8ecca281d5a3}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{end, }
\item[{const {\bf DMatrix} \&}]{ColIndx}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_ad9815228adc3856c7cdc8ecca281d5a3}


Sub-\/vector extraction and referencing using an array of column indices for the last column of a matrix. 


\begin{DoxyParams}{Parameters}
{\em end} & is a character string containing the word \char`\"{}end\char`\"{}. \\
\hline
{\em ColIndx} & is a \hyperlink{classDMatrix}{DMatrix} array that contains column index values usually generated using the \hyperlink{classDMatrix_a2987194d90eec1f076a329414ac07278}{colon()} function. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a \hyperlink{classDMatrix}{DMatrix} mtype 1 object that maps to the referenced elements of the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a8a1118191a95c48e44043ddb89dbd826}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{end}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a8a1118191a95c48e44043ddb89dbd826}


Access to last linear element. Returns a reference to the last linear matrix element, assuming column major storage. 


\begin{DoxyParams}{Parameters}
{\em end,:} & Character string containing the word \char`\"{}end\char`\"{}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
reference to indexed matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a2716e6ec24ea80068a5baec55e98c370}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{RowIndx, }
\item[{const {\bf DMatrix} \&}]{ColIndx}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a2716e6ec24ea80068a5baec55e98c370}


Submatrix extraction and referencing using arrays of indices. 


\begin{DoxyParams}{Parameters}
{\em RowIndx} & is a \hyperlink{classDMatrix}{DMatrix} array that contains row index values usually generated using the \hyperlink{classDMatrix_a2987194d90eec1f076a329414ac07278}{colon()} function. \\
\hline
{\em ColIndx} & is a \hyperlink{classDMatrix}{DMatrix} array that contains column index values usually generated using the \hyperlink{classDMatrix_a2987194d90eec1f076a329414ac07278}{colon()} function. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a \hyperlink{classDMatrix}{DMatrix} mtype 1 object that maps to the referenced elements of the calling object. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a160cbc57bd615ceb60ebdb500371a37c}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{RowIndx}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a160cbc57bd615ceb60ebdb500371a37c}


Linear sub-\/vector extraction and referencing using an array of indices assuming column-\/major storage. 


\begin{DoxyParams}{Parameters}
{\em RowIndx} & is a \hyperlink{classDMatrix}{DMatrix} array that contains row index values usually generated using the \hyperlink{classDMatrix_a2987194d90eec1f076a329414ac07278}{colon()} function. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a \hyperlink{classDMatrix}{DMatrix} mtype 1 object that maps to the referenced elements of the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad944a2f5b2df21a1ae752f368e257f34}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{long}]{row, }
\item[{long}]{col}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_ad944a2f5b2df21a1ae752f368e257f34}


Matrix indexing. Returns a reference to the matrix element located at the position indicated by the row and column indices. Indices start from 1. 


\begin{DoxyParams}{Parameters}
{\em row,:} & Row index starting from 1. \\
\hline
{\em col,:} & Column index starting from 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the indexed matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a15adc46b55cb516b67bb408447f8275e}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{long}]{row, }
\item[{const char $\ast$}]{end}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a15adc46b55cb516b67bb408447f8275e}


Matrix indexing. Returns a reference to the matrix element located at the position indicated by the row index and the last column. Indices start from 1. An error in thrown in case of zero or negative indices. The matrix is resized if necessary. 


\begin{DoxyParams}{Parameters}
{\em row,:} & Row index starting from 1. \\
\hline
{\em end,:} & Character string containing the word \char`\"{}end\char`\"{}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the indexed matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a430e6b0a88061c4fe70e1c64ccaf285a}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{end, }
\item[{long}]{col}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a430e6b0a88061c4fe70e1c64ccaf285a}


Matrix indexing. Returns a reference to the matrix element located at the position indicated by the column index and the last row. Indices start from 1. An error in thrown in case of a range violation. 


\begin{DoxyParams}{Parameters}
{\em end,:} & Character string containing the word \char`\"{}end\char`\"{}. \\
\hline
{\em col,:} & Column index starting from 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the indexed matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_af44540d97b6e449fd3f1551956ea2518}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{long}]{row, }
\item[{const {\bf DMatrix} \&}]{ColIndx}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_af44540d97b6e449fd3f1551956ea2518}


Sub-\/vector extraction and referencing using an array of column indices for a given row. 


\begin{DoxyParams}{Parameters}
{\em row} & is a row index. \\
\hline
{\em ColIndx} & is a \hyperlink{classDMatrix}{DMatrix} array that contains column index values usually generated using the \hyperlink{classDMatrix_a2987194d90eec1f076a329414ac07278}{colon()} function. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a \hyperlink{classDMatrix}{DMatrix} mtype 1 object that maps to the referenced elements of the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_aafb023a91a09e10f3c95414b29a32d22}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{long}]{row, }
\item[{const char $\ast$}]{end}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_aafb023a91a09e10f3c95414b29a32d22}


Matrix indexing. Returns the value of the matrix element located at the position indicated by the row index and the last column. Indices start from 1. An error in thrown in case of a range violation. 


\begin{DoxyParams}{Parameters}
{\em row,:} & Row index starting from 1. \\
\hline
{\em end,:} & Character string containing the word \char`\"{}end\char`\"{}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
double value of the indexed matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6f6ad5489850d8200b6a49c9da098877}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{long}]{index}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a6f6ad5489850d8200b6a49c9da098877}


Single index matrix indexing. Returns a reference to the matrix element located at the linear position indicated by the index, assuming column major storage. The indexs start from 1. The matrix is resized if necessary. An error is thrown in case of zero or negative indices. 


\begin{DoxyParams}{Parameters}
{\em index,:} & index value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
reference to indexed matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a847dc65e8a09a3274b7a6e54acb37a17}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{RowIndx, }
\item[{const char $\ast$}]{end}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a847dc65e8a09a3274b7a6e54acb37a17}


Sub-\/vector extraction and referencing using an array of row indices for the last column of a matrix. 


\begin{DoxyParams}{Parameters}
{\em RowIndx} & is a \hyperlink{classDMatrix}{DMatrix} array that contains row index values usually generated using the \hyperlink{classDMatrix_a2987194d90eec1f076a329414ac07278}{colon()} function. \\
\hline
{\em end} & is a character string containing the word \char`\"{}end\char`\"{}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a \hyperlink{classDMatrix}{DMatrix} mtype 1 object that maps to the referenced elements of the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a181f357abea59bca3f4d9efb16fb5618}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{long}]{k}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a181f357abea59bca3f4d9efb16fb5618}


Single index matrix indexing. Returns the value of the matrix element located at the linear position indicated by the index, assuming column major storage. The index starts from 1. An error is thrown in case of range error. 


\begin{DoxyParams}{Parameters}
{\em k,:} & index value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Value of indexed matrix element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a1e736f0992464a5d849ebbe5a4eb3bbf}{
\index{DMatrix@{DMatrix}!operator()@{operator()}}
\index{operator()@{operator()}!DMatrix@{DMatrix}}
\subsubsection[{operator()}]{\setlength{\rightskip}{0pt plus 5cm}double DMatrix::operator() (
\begin{DoxyParamCaption}
\item[{long}]{row, }
\item[{long}]{col}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a1e736f0992464a5d849ebbe5a4eb3bbf}


Matrix indexing. Returns the value of the matrix element located at the position indicated by the row and column indices. Indices start from 1. An error in thrown in case of a range violation. 


\begin{DoxyParams}{Parameters}
{\em row,:} & Row index starting from 1. \\
\hline
{\em col,:} & Column index starting from 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
double value of the indexed element. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a17a7fbea90ec8a16e4ced726128d4b5f}{
\index{DMatrix@{DMatrix}!operator$\ast$@{operator$\ast$}}
\index{operator$\ast$@{operator$\ast$}!DMatrix@{DMatrix}}
\subsubsection[{operator$\ast$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$\ast$ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a17a7fbea90ec8a16e4ced726128d4b5f}


Matrix product operator. Returns the result of the matrix product of the calling object (left hand side of the operator) and the right hand side object. The inner dimensions of the objects being multiplied should be consistent, otherwise an error will be thrown. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & matrix located at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a671296ddd1c619d1ee31a308ac56840c}{
\index{DMatrix@{DMatrix}!operator$\ast$@{operator$\ast$}}
\index{operator$\ast$@{operator$\ast$}!DMatrix@{DMatrix}}
\subsubsection[{operator$\ast$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$\ast$ (
\begin{DoxyParamCaption}
\item[{double}]{Arg}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a671296ddd1c619d1ee31a308ac56840c}


Computes the product of a matrix (left hand side of the operator) times a real scalar (right hand side value) and replaces the left hand side object with the result of the operation. 


\begin{DoxyParams}{Parameters}
{\em Arg,:} & double value that will multiply each element of the matrix. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference the calling \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_afe1c2b5daad8e441bb1da8edeccbe6a2}{
\index{DMatrix@{DMatrix}!operator$\ast$=@{operator$\ast$=}}
\index{operator$\ast$=@{operator$\ast$=}!DMatrix@{DMatrix}}
\subsubsection[{operator$\ast$=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$\ast$= (
\begin{DoxyParamCaption}
\item[{double}]{Arg}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_afe1c2b5daad8e441bb1da8edeccbe6a2}


Computes the product of a matrix (left hand side of the operator) times a real scalar (right hand side value), and modifies the calling object to store the result of the operation. 


\begin{DoxyParams}{Parameters}
{\em Arg,:} & double value that will multiply each element of the matrix. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the calling \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_abda7d982b252b058549dbe48ec1276ba}{
\index{DMatrix@{DMatrix}!operator$\ast$=@{operator$\ast$=}}
\index{operator$\ast$=@{operator$\ast$=}!DMatrix@{DMatrix}}
\subsubsection[{operator$\ast$=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$\ast$= (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_abda7d982b252b058549dbe48ec1276ba}


Matrix product operator with substitution. Computes the matrix product of the calling object (left hand side of the operator) and the right hand side object. The inner dimensions of the objects being multiplied should be consistent, otherwise an error will be thrown. The calling object is modified to store the results of the operation. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & matrix located at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the calling \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac87ec83dbff242d422e1cb369bd2ca88}{
\index{DMatrix@{DMatrix}!operator+@{operator+}}
\index{operator+@{operator+}!DMatrix@{DMatrix}}
\subsubsection[{operator+}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator+ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_ac87ec83dbff242d422e1cb369bd2ca88}


Matrix addition operator. The sizes of the matrices being added should be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & matrix located at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a666ade216863c56a4c349bb8fee0b972}{
\index{DMatrix@{DMatrix}!operator+@{operator+}}
\index{operator+@{operator+}!DMatrix@{DMatrix}}
\subsubsection[{operator+}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator+ (
\begin{DoxyParamCaption}
\item[{double}]{x}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a666ade216863c56a4c349bb8fee0b972}


Adds a scalar real value to each element of the matrix. . 


\begin{DoxyParams}{Parameters}
{\em x,:} & double value to be added \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_add9bb19634bb522c9e877491094e738c}{
\index{DMatrix@{DMatrix}!operator+=@{operator+=}}
\index{operator+=@{operator+=}!DMatrix@{DMatrix}}
\subsubsection[{operator+=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator+= (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_add9bb19634bb522c9e877491094e738c}


Matrix addition and substitution operator. The sizes of the matrices being added should be the same, otherwise an error is thrown.The left hand side object elements are replaced with the result of the operation. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & matrix located right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac0a611dd59097d0a3920abf376d054e7}{
\index{DMatrix@{DMatrix}!operator-\/@{operator-\/}}
\index{operator-\/@{operator-\/}!DMatrix@{DMatrix}}
\subsubsection[{operator-\/}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator-\/ (
\begin{DoxyParamCaption}
\item[{double}]{x}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_ac0a611dd59097d0a3920abf376d054e7}


Subtracts a scalar real value from each element of the matrix. . 


\begin{DoxyParams}{Parameters}
{\em x,:} & double value to be subtracted \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_adf28e5ff346309620d9dded905cf5b22}{
\index{DMatrix@{DMatrix}!operator-\/@{operator-\/}}
\index{operator-\/@{operator-\/}!DMatrix@{DMatrix}}
\subsubsection[{operator-\/}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator-\/ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_adf28e5ff346309620d9dded905cf5b22}


Matrix subtraction operator. The sizes of the matrices being subtracted should be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & matrix located at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a9535ca71463a4e2f687b680569c9dd75}{
\index{DMatrix@{DMatrix}!operator-\/=@{operator-\/=}}
\index{operator-\/=@{operator-\/=}!DMatrix@{DMatrix}}
\subsubsection[{operator-\/=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator-\/= (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a9535ca71463a4e2f687b680569c9dd75}


Matrix subtraction and substitution operator. The sizes of the matrices being subtracted should be the same, otherwise an error is thrown.The left hand side object elements are replaced with the result of the operation. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & matrix located right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a3b8d471ba4ef3cd2e9dc5931e5b77e01}{
\index{DMatrix@{DMatrix}!operator/@{operator/}}
\index{operator/@{operator/}!DMatrix@{DMatrix}}
\subsubsection[{operator/}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator/ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a3b8d471ba4ef3cd2e9dc5931e5b77e01}


Computes the right division of a matrix (left hand side of the operator) by another matrix (right hand side value). This is conceptually equivalent to multiplying the left object by the inverse of the right hand side object but it is computed in a more efficient way. The dimensions of the matrices must be consistent, otherwise an error is returned. The right hand side object must be a square matrix. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & \hyperlink{classDMatrix}{DMatrix} object at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ae58c7f379fbb88acad6b704961f7029c}{
\index{DMatrix@{DMatrix}!operator/@{operator/}}
\index{operator/@{operator/}!DMatrix@{DMatrix}}
\subsubsection[{operator/}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator/ (
\begin{DoxyParamCaption}
\item[{double}]{Arg}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_ae58c7f379fbb88acad6b704961f7029c}


Computes the division of a matrix (left hand side of the operator) by a real scalar (right hand side value). 


\begin{DoxyParams}{Parameters}
{\em Arg,:} & double value that will divide each element of the matrix. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ab57902d452e18ec32edbfb300a59940f}{
\index{DMatrix@{DMatrix}!operator/=@{operator/=}}
\index{operator/=@{operator/=}!DMatrix@{DMatrix}}
\subsubsection[{operator/=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator/= (
\begin{DoxyParamCaption}
\item[{double}]{Arg}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_ab57902d452e18ec32edbfb300a59940f}


Computes the division of a matrix (left hand side of the operator) by a real scalar (right hand side value) and modifies the left hand side object with the result of the operation. 


\begin{DoxyParams}{Parameters}
{\em Arg,:} & double value that will divide each element of the matrix. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a60f1f1c8766a649c91c64243a7f37b77}{
\index{DMatrix@{DMatrix}!operator$<$@{operator$<$}}
\index{operator$<$@{operator$<$}!DMatrix@{DMatrix}}
\subsubsection[{operator$<$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$<$ (
\begin{DoxyParamCaption}
\item[{double}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a60f1f1c8766a649c91c64243a7f37b77}


Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is lower than the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. 


\begin{DoxyParams}{Parameters}
{\em val,:} & right hand side value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac488bfc1076b6e69fdb8cb8e37acdff4}{
\index{DMatrix@{DMatrix}!operator$<$@{operator$<$}}
\index{operator$<$@{operator$<$}!DMatrix@{DMatrix}}
\subsubsection[{operator$<$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$<$ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_ac488bfc1076b6e69fdb8cb8e37acdff4}


Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is lower than the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em val,:} & val: right hand side object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a220c708ecc6554de0abf07788eb9ab89}{
\index{DMatrix@{DMatrix}!operator$<$=@{operator$<$=}}
\index{operator$<$=@{operator$<$=}!DMatrix@{DMatrix}}
\subsubsection[{operator$<$=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$<$= (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a220c708ecc6554de0abf07788eb9ab89}


Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is lower or equal than the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em val,:} & val: right hand side object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a2f0eadd7bb2b7afc5e6109243a839c1d}{
\index{DMatrix@{DMatrix}!operator$<$=@{operator$<$=}}
\index{operator$<$=@{operator$<$=}!DMatrix@{DMatrix}}
\subsubsection[{operator$<$=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$<$= (
\begin{DoxyParamCaption}
\item[{double}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a2f0eadd7bb2b7afc5e6109243a839c1d}


Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is lower or equal than the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. 


\begin{DoxyParams}{Parameters}
{\em val,:} & right hand side value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_add548c8713cb71b189a0535d05a37cc9}{
\index{DMatrix@{DMatrix}!operator=@{operator=}}
\index{operator=@{operator=}!DMatrix@{DMatrix}}
\subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator= (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{rval}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_add548c8713cb71b189a0535d05a37cc9}


Matrix assignment. The size of the left hand side object is modified if necessary, and the values of all real elements of the right hand side object and copied to the left hand side object. 


\begin{DoxyParams}{Parameters}
{\em rval,:} & \hyperlink{classDMatrix}{DMatrix} object at the right hand side of the operator \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_af94a79c28f61abb7ef91c97a5113f2d4}{
\index{DMatrix@{DMatrix}!operator=@{operator=}}
\index{operator=@{operator=}!DMatrix@{DMatrix}}
\subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator= (
\begin{DoxyParamCaption}
\item[{double}]{val}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_af94a79c28f61abb7ef91c97a5113f2d4}


Matrix assignment to a scalar. The size of the left hand side object is modified to one row by one column if necessary, and the value of the right hand side argument is copied to the single element of the matrix. If the calling object is a \char`\"{}colon reference\char`\"{} matrix, then the right hand side value is copied to each element of the referenced array elements. 


\begin{DoxyParams}{Parameters}
{\em val,:} & double value at the right hand side of the operator \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a5625e608ef4e437bdce83858df5b3c97}{
\index{DMatrix@{DMatrix}!operator=@{operator=}}
\index{operator=@{operator=}!DMatrix@{DMatrix}}
\subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator= (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{str}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a5625e608ef4e437bdce83858df5b3c97}


Matrix assignment to a constant matrix defined as a character string using the bracket notation used in Matlab and Octave. The size of the left hand side object is modified if necessary. For example, the identity matrix of size two by two would be entered as \char`\"{}\mbox{[}1.0  0.0;0.0  1.0\mbox{]}\char`\"{}. 


\begin{DoxyParams}{Parameters}
{\em str,:} & Character string containing the constant matrix defined using Matlab/Octave bracket notation. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to the calling object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a9851dca0d4acb9001926dfef3d4226b8}{
\index{DMatrix@{DMatrix}!operator==@{operator==}}
\index{operator==@{operator==}!DMatrix@{DMatrix}}
\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator== (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a9851dca0d4acb9001926dfef3d4226b8}


Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is equal to the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em val,:} & val: right hand side object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a02a8277b7f165d774d6463f284bb71b4}{
\index{DMatrix@{DMatrix}!operator==@{operator==}}
\index{operator==@{operator==}!DMatrix@{DMatrix}}
\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator== (
\begin{DoxyParamCaption}
\item[{double}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a02a8277b7f165d774d6463f284bb71b4}


Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is equal to the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. 


\begin{DoxyParams}{Parameters}
{\em val,:} & right hand side value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a1cb2ee04434b9874b01bc1494f49c639}{
\index{DMatrix@{DMatrix}!operator$>$@{operator$>$}}
\index{operator$>$@{operator$>$}!DMatrix@{DMatrix}}
\subsubsection[{operator$>$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$>$ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a1cb2ee04434b9874b01bc1494f49c639}


Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is greater than the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em val,:} & val: right hand side object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac13b6fc14bdd5f3947cccb8f41173433}{
\index{DMatrix@{DMatrix}!operator$>$@{operator$>$}}
\index{operator$>$@{operator$>$}!DMatrix@{DMatrix}}
\subsubsection[{operator$>$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$>$ (
\begin{DoxyParamCaption}
\item[{double}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_ac13b6fc14bdd5f3947cccb8f41173433}


Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is greater than the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. 


\begin{DoxyParams}{Parameters}
{\em val,:} & right hand side value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_adf2cf4223a098eb273fd3b6c71fea201}{
\index{DMatrix@{DMatrix}!operator$>$=@{operator$>$=}}
\index{operator$>$=@{operator$>$=}!DMatrix@{DMatrix}}
\subsubsection[{operator$>$=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$>$= (
\begin{DoxyParamCaption}
\item[{double}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_adf2cf4223a098eb273fd3b6c71fea201}


Checks if each element of the \hyperlink{classDMatrix}{DMatrix} object on the left hand side is greater or equal than the right hand side value. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. 


\begin{DoxyParams}{Parameters}
{\em val,:} & right hand side value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac17447effdb7cfc9252bf5232c3e99d6}{
\index{DMatrix@{DMatrix}!operator$>$=@{operator$>$=}}
\index{operator$>$=@{operator$>$=}!DMatrix@{DMatrix}}
\subsubsection[{operator$>$=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$>$= (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{val}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_ac17447effdb7cfc9252bf5232c3e99d6}


Elementwise matrix comparison. Checks if each element of the matrix on the left hand side is greater or equal than the corresponding element of the right hand side matrix. The result is a \hyperlink{classDMatrix}{DMatrix} object where each element has the value of 1 if the corresponding comparison was true, 0 otherwise. The dimensions of the two matrices involved must be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em val,:} & val: right hand side object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_af380c4e561b0f321b5bf7103038fa2cb}{
\index{DMatrix@{DMatrix}!operator$^\wedge$@{operator$^\wedge$}}
\index{operator$^\wedge$@{operator$^\wedge$}!DMatrix@{DMatrix}}
\subsubsection[{operator$^\wedge$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$^\wedge$ (
\begin{DoxyParamCaption}
\item[{double}]{x}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_af380c4e561b0f321b5bf7103038fa2cb}


Elementwise power operator. Returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions of the calling object and each of its elements is computed as the corresponding element of the calling object to the power of the right hand side argument. Care must be taken when using this operator as the associations do not work in the same way as with the $\ast$ operator. It is highly recommended to use parenthesis every time this operator is used. For example use it as follows: (A$^\wedge$x). 


\begin{DoxyParams}{Parameters}
{\em x,:} & double argument at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ada9cc203a754a96ac3cb6122c9eba0fd}{
\index{DMatrix@{DMatrix}!operator$|$@{operator$|$}}
\index{operator$|$@{operator$|$}!DMatrix@{DMatrix}}
\subsubsection[{operator$|$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$|$ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix}}]{B}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_ada9cc203a754a96ac3cb6122c9eba0fd}


Elementwise division operator. Returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions of the calling objects and each of its elements is computed as the of the corresponding element of the calling object by the corresponding element of the right hand side object. The dimensions of the calling objects must be the same, otherwise an error is thrown. Care must be taken when using this operator as the associations do not work in the same way as with the / operator. It is highly recommended to use parenthesis every time this operator is used. For example use it as follows: (A$|$B). 


\begin{DoxyParams}{Parameters}
{\em B,:} & \hyperlink{classDMatrix}{DMatrix} object at the right hand side of the operator \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a7b756f28bc990d6b5b67a176143b9fc0}{
\index{DMatrix@{DMatrix}!operator$|$$|$@{operator$|$$|$}}
\index{operator$|$$|$@{operator$|$$|$}!DMatrix@{DMatrix}}
\subsubsection[{operator$|$$|$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::operator$|$$|$ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a7b756f28bc990d6b5b67a176143b9fc0}


Concatenates two matrices side by side. The dimensions number of rows of the matrices involved must be the same, otherwise an error is thrown. The number of columns of the resulting matrix is the addition of the number of columns of both matrices involved. 


\begin{DoxyParams}{Parameters}
{\em B,:} & \hyperlink{classDMatrix}{DMatrix} object at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a998b1e7e9dd6c837971f264660075efe}{
\index{DMatrix@{DMatrix}!Print@{Print}}
\index{Print@{Print}!DMatrix@{DMatrix}}
\subsubsection[{Print}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::Print (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{text}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a998b1e7e9dd6c837971f264660075efe}


Prints the elements of a \hyperlink{classDMatrix}{DMatrix} object. 


\begin{DoxyParams}{Parameters}
{\em text} & is a string that serves as a prompt for the matrix being entered. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6e471ebaba82f41591b69fdfc8d72eaa}{
\index{DMatrix@{DMatrix}!PrintInfo@{PrintInfo}}
\index{PrintInfo@{PrintInfo}!DMatrix@{DMatrix}}
\subsubsection[{PrintInfo}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::PrintInfo (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{text}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a6e471ebaba82f41591b69fdfc8d72eaa}


Prints information about a \hyperlink{classDMatrix}{DMatrix} object. 


\begin{DoxyParams}{Parameters}
{\em text} & is a a string that serves as a label for the matrix being printed. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac79a34758fce637c1f23149f267ed623}{
\index{DMatrix@{DMatrix}!random\_\-gaussian@{random\_\-gaussian}}
\index{random\_\-gaussian@{random\_\-gaussian}!DMatrix@{DMatrix}}
\subsubsection[{random\_\-gaussian}]{\setlength{\rightskip}{0pt plus 5cm}static double DMatrix::random\_\-gaussian (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classDMatrix_ac79a34758fce637c1f23149f267ed623}


Returns a pseudo-\/random Gaussian distributed number with zero mean and unit variance. 

\begin{DoxyReturn}{Returns}
double Gaussian pseudo-\/random value 
\end{DoxyReturn}
\hypertarget{classDMatrix_a02bef7569ab47374e79f9acd9fa517b2}{
\index{DMatrix@{DMatrix}!random\_\-uniform@{random\_\-uniform}}
\index{random\_\-uniform@{random\_\-uniform}!DMatrix@{DMatrix}}
\subsubsection[{random\_\-uniform}]{\setlength{\rightskip}{0pt plus 5cm}static double DMatrix::random\_\-uniform (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classDMatrix_a02bef7569ab47374e79f9acd9fa517b2}


Returns a pseudo-\/random uniformly distributed number in the range \mbox{[}0,1\mbox{]}. 

\begin{DoxyReturn}{Returns}
double pseudo-\/random value in the range \mbox{[}0,1\mbox{]} 
\end{DoxyReturn}
\hypertarget{classDMatrix_a12b3c21b0467172f8a6ae976f04a9e99}{
\index{DMatrix@{DMatrix}!Read@{Read}}
\index{Read@{Read}!DMatrix@{DMatrix}}
\subsubsection[{Read}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::Read (
\begin{DoxyParamCaption}
\item[{FILE $\ast$}]{filex}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a12b3c21b0467172f8a6ae976f04a9e99}


Reads the elements of a matrix from a file. 

The file in question should contain the elements of the matrix row by row The elements should be separated by spaces and each row should be separated by a new line. The calling object should have the appropriate number of rows and columns. 
\begin{DoxyParams}{Parameters}
{\em filex} & pointer to a file already opened using \char`\"{}fopen()\char`\"{}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a523236d1477888fc53f74bbc00a30fa6}{
\index{DMatrix@{DMatrix}!Resize@{Resize}}
\index{Resize@{Resize}!DMatrix@{DMatrix}}
\subsubsection[{Resize}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::Resize (
\begin{DoxyParamCaption}
\item[{long}]{nnrow, }
\item[{long}]{nncol}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a523236d1477888fc53f74bbc00a30fa6}


Changes the number of rows and columns of an existing matrix. Allocates new memory if necessary. If the calling object uses preallocated memory and the requested size would exceed that memory, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em nnrow,:} & new number of rows \\
\hline
{\em nncol,:} & new number of columns \\
\hline
\end{DoxyParams}
\hypertarget{classDMatrix_a90261694eb6d26818dfbebbe099c1373}{
\index{DMatrix@{DMatrix}!Row@{Row}}
\index{Row@{Row}!DMatrix@{DMatrix}}
\subsubsection[{Row}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::Row (
\begin{DoxyParamCaption}
\item[{long}]{irow}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a90261694eb6d26818dfbebbe099c1373}


Returns a \hyperlink{classDMatrix}{DMatrix} object containing a speficied row of the calling object. 


\begin{DoxyParams}{Parameters}
{\em irow,:} & row index (starting from 1) \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{classDMatrix}{DMatrix} object with the specified row 
\end{DoxyReturn}
\hypertarget{classDMatrix_a3907e2350b967ee27825eb9b9c6f4992}{
\index{DMatrix@{DMatrix}!rowMult@{rowMult}}
\index{rowMult@{rowMult}!DMatrix@{DMatrix}}
\subsubsection[{rowMult}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::rowMult (
\begin{DoxyParamCaption}
\item[{long}]{r, }
\item[{double}]{x}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a3907e2350b967ee27825eb9b9c6f4992}


Multiples the elements of a specified row of a matrix by a constant scalar value. 


\begin{DoxyParams}{Parameters}
{\em r,:} & index to the row that is to be changed \\
\hline
{\em x,:} & scalar value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a67346b3c1a7e04b0e071e59e06b5399a}{
\index{DMatrix@{DMatrix}!Save@{Save}}
\index{Save@{Save}!DMatrix@{DMatrix}}
\subsubsection[{Save}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::Save (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{FileName}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a67346b3c1a7e04b0e071e59e06b5399a}


Saves the elements of a matrix to a file. 


\begin{DoxyParams}{Parameters}
{\em FileName} & is a string with the desired file name \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a877dbfd1042abd3391f77a4aaf90c296}{
\index{DMatrix@{DMatrix}!SetColIndexPointer@{SetColIndexPointer}}
\index{SetColIndexPointer@{SetColIndexPointer}!DMatrix@{DMatrix}}
\subsubsection[{SetColIndexPointer}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SetColIndexPointer (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} $\ast$}]{arg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, protected\mbox{]}}}}
\label{classDMatrix_a877dbfd1042abd3391f77a4aaf90c296}


Sets the column index pointer. 


\begin{DoxyParams}{Parameters}
{\em arg} & Pointer to \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_af2c9e4ddf67ac9cf85141f1afb6cde37}{
\index{DMatrix@{DMatrix}!SetColumn@{SetColumn}}
\index{SetColumn@{SetColumn}!DMatrix@{DMatrix}}
\subsubsection[{SetColumn}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SetColumn (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{Col, }
\item[{int}]{icol}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_af2c9e4ddf67ac9cf85141f1afb6cde37}


Assigns values to a column of a matrix, while other columns are left untouched. 


\begin{DoxyParams}{Parameters}
{\em Col,:} & reference to constant \hyperlink{classDMatrix}{DMatrix} object which should contain a vector with the desired column values \\
\hline
{\em icol,:} & index to the column that is to be changed \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_aeb006280bc37e1d13ecf16164fff0f5c}{
\index{DMatrix@{DMatrix}!SetMType@{SetMType}}
\index{SetMType@{SetMType}!DMatrix@{DMatrix}}
\subsubsection[{SetMType}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SetMType (
\begin{DoxyParamCaption}
\item[{int}]{arg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}protected\mbox{]}}}}
\label{classDMatrix_aeb006280bc37e1d13ecf16164fff0f5c}


Sets the type of matrix. 


\begin{DoxyParams}{Parameters}
{\em arg} & (int) should be 0 for a normal matrix, or 1 for a colon reference matrix \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a7521e5968a095edd6b80779f95b25309}{
\index{DMatrix@{DMatrix}!SetPrintLevel@{SetPrintLevel}}
\index{SetPrintLevel@{SetPrintLevel}!DMatrix@{DMatrix}}
\subsubsection[{SetPrintLevel}]{\setlength{\rightskip}{0pt plus 5cm}static void DMatrix::SetPrintLevel (
\begin{DoxyParamCaption}
\item[{int}]{plevel}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}static\mbox{]}}}}
\label{classDMatrix_a7521e5968a095edd6b80779f95b25309}


Sets the print level. 


\begin{DoxyParams}{Parameters}
{\em plevel} & desired print level \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac13795ccdc5f59c8bcec90207f484fe8}{
\index{DMatrix@{DMatrix}!SetReferencedDMatrixPointer@{SetReferencedDMatrixPointer}}
\index{SetReferencedDMatrixPointer@{SetReferencedDMatrixPointer}!DMatrix@{DMatrix}}
\subsubsection[{SetReferencedDMatrixPointer}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SetReferencedDMatrixPointer (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} $\ast$}]{arg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, protected\mbox{]}}}}
\label{classDMatrix_ac13795ccdc5f59c8bcec90207f484fe8}


Sets the value of the referenced matrix pointer. 


\begin{DoxyParams}{Parameters}
{\em arg} & Pointer to \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a8cc97e6d3bb30a15c521d822638949eb}{
\index{DMatrix@{DMatrix}!SetRow@{SetRow}}
\index{SetRow@{SetRow}!DMatrix@{DMatrix}}
\subsubsection[{SetRow}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SetRow (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{Row, }
\item[{int}]{irow}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a8cc97e6d3bb30a15c521d822638949eb}


Assigns values to a row of a matrix, while other columns are left untouched. 


\begin{DoxyParams}{Parameters}
{\em Row,:} & reference to constant \hyperlink{classDMatrix}{DMatrix} object which should contain a vector with the desired row values \\
\hline
{\em irow,:} & index to the row that is to be changed \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a73b829dadf5b159839b57a399f1fa8c8}{
\index{DMatrix@{DMatrix}!SetRowIndexPointer@{SetRowIndexPointer}}
\index{SetRowIndexPointer@{SetRowIndexPointer}!DMatrix@{DMatrix}}
\subsubsection[{SetRowIndexPointer}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SetRowIndexPointer (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} $\ast$}]{arg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, protected\mbox{]}}}}
\label{classDMatrix_a73b829dadf5b159839b57a399f1fa8c8}


Sets the row index pointer. 


\begin{DoxyParams}{Parameters}
{\em arg} & Pointer to \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a580fc5ea46fe5208dd49a9f1ade06e20}{
\index{DMatrix@{DMatrix}!SetSubMatrix@{SetSubMatrix}}
\index{SetSubMatrix@{SetSubMatrix}!DMatrix@{DMatrix}}
\subsubsection[{SetSubMatrix}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SetSubMatrix (
\begin{DoxyParamCaption}
\item[{long}]{row, }
\item[{long}]{col, }
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a580fc5ea46fe5208dd49a9f1ade06e20}


Assigns the elements of a matrix object to a section of the calling object. 


\begin{DoxyParams}{Parameters}
{\em row,:} & start of row range \\
\hline
{\em col,:} & start of column range \\
\hline
{\em A,:} & \hyperlink{classDMatrix}{DMatrix} object whose element values are to be copied into the calling object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6c8455bfd3811abb82bca639f2ead3af}{
\index{DMatrix@{DMatrix}!sub\_\-matrix@{sub\_\-matrix}}
\index{sub\_\-matrix@{sub\_\-matrix}!DMatrix@{DMatrix}}
\subsubsection[{sub\_\-matrix}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& DMatrix::sub\_\-matrix (
\begin{DoxyParamCaption}
\item[{long}]{r1, }
\item[{long}]{r2, }
\item[{long}]{c1, }
\item[{long}]{c2}
\end{DoxyParamCaption}
) const}}
\label{classDMatrix_a6c8455bfd3811abb82bca639f2ead3af}


Extracts a specified sub-\/matrix from a matrix. 


\begin{DoxyParams}{Parameters}
{\em r1,:} & start of row range \\
\hline
{\em r2,:} & end of row range \\
\hline
{\em c1,:} & start of column range \\
\hline
{\em c2,:} & end of column range \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
\hyperlink{classDMatrix}{DMatrix} object with the specified sub-\/matrix 
\end{DoxyReturn}
\hypertarget{classDMatrix_a3b9322caa649274e47049960b1f60a33}{
\index{DMatrix@{DMatrix}!SwapColumns@{SwapColumns}}
\index{SwapColumns@{SwapColumns}!DMatrix@{DMatrix}}
\subsubsection[{SwapColumns}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SwapColumns (
\begin{DoxyParamCaption}
\item[{int}]{i, }
\item[{int}]{j}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a3b9322caa649274e47049960b1f60a33}


Swaps two columns of a matrix. 


\begin{DoxyParams}{Parameters}
{\em i,:} & first column index \\
\hline
{\em j,:} & second column index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a78d654687b6b56497279a81bdc28d4f7}{
\index{DMatrix@{DMatrix}!SwapRows@{SwapRows}}
\index{SwapRows@{SwapRows}!DMatrix@{DMatrix}}
\subsubsection[{SwapRows}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::SwapRows (
\begin{DoxyParamCaption}
\item[{int}]{i, }
\item[{int}]{j}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a78d654687b6b56497279a81bdc28d4f7}


Swaps two rows of a matrix. 


\begin{DoxyParams}{Parameters}
{\em i,:} & first row index \\
\hline
{\em j,:} & second row index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a23e7c1ac8350421a1798a59363452f79}{
\index{DMatrix@{DMatrix}!Transpose@{Transpose}}
\index{Transpose@{Transpose}!DMatrix@{DMatrix}}
\subsubsection[{Transpose}]{\setlength{\rightskip}{0pt plus 5cm}void DMatrix::Transpose (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}
\label{classDMatrix_a23e7c1ac8350421a1798a59363452f79}


Transposes a matrix. 

\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}


\subsection{Friends And Related Function Documentation}
\hypertarget{classDMatrix_a8de28f4be67d64533552e166b44ea128}{
\index{DMatrix@{DMatrix}!Abs@{Abs}}
\index{Abs@{Abs}!DMatrix@{DMatrix}}
\subsubsection[{Abs}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& Abs (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a8de28f4be67d64533552e166b44ea128}


This function computes and returns the element-\/wise absolute value of matrix A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation. 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad90390441283c128e0c64ad67b7a7d16}{
\index{DMatrix@{DMatrix}!any@{any}}
\index{any@{any}!DMatrix@{DMatrix}}
\subsubsection[{any}]{\setlength{\rightskip}{0pt plus 5cm}int any (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad90390441283c128e0c64ad67b7a7d16}


This function returns a 1 if any alement of \hyperlink{classDMatrix}{DMatrix} object that is passed as argument is non-\/zero, otherwise it returns a zero. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
an integer value which is either 1 or 0. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a1266502a32517e157a8a56a312e13b54}{
\index{DMatrix@{DMatrix}!Chol@{Chol}}
\index{Chol@{Chol}!DMatrix@{DMatrix}}
\subsubsection[{Chol}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& Chol (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a1266502a32517e157a8a56a312e13b54}


Returns the Cholesky factorisation of a matrix A, which must be a positive definite symmetric matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object· \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_ae5b99d9b1b937f38054ac8d16237b1c2}{CholFSolve()}, \hyperlink{classDMatrix_a0167e219388b005d7b41ea3403191fd3}{CholSolve()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_ae96d9db92ff5e3a72e0e7b0eda05490f}{
\index{DMatrix@{DMatrix}!CholeskyDecomp@{CholeskyDecomp}}
\index{CholeskyDecomp@{CholeskyDecomp}!DMatrix@{DMatrix}}
\subsubsection[{CholeskyDecomp}]{\setlength{\rightskip}{0pt plus 5cm}void CholeskyDecomp (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} \&}]{A, }
\item[{int}]{n, }
\item[{{\bf DMatrix} \&}]{pM}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ae96d9db92ff5e3a72e0e7b0eda05490f}


Cholesky decomposition of a matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em n} & is the number of columns of the input matrix A. \\
\hline
{\em pM} & (modified), is a \hyperlink{classDMatrix}{DMatrix} object which on output contains the Cholesky decomposition of input matrix a. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_ac66ec50116a7b447a9ba3d0cc38043eb}{CholeskySolution()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_af65da2b06dfaa39404003f6a7d09121b}{
\index{DMatrix@{DMatrix}!CholeskyRoot@{CholeskyRoot}}
\index{CholeskyRoot@{CholeskyRoot}!DMatrix@{DMatrix}}
\subsubsection[{CholeskyRoot}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& CholeskyRoot (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_af65da2b06dfaa39404003f6a7d09121b}


Returns the Cholesky root R of a given matrix A, such that A=R'R. A must be a positive definite symmetric matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object· \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac66ec50116a7b447a9ba3d0cc38043eb}{
\index{DMatrix@{DMatrix}!CholeskySolution@{CholeskySolution}}
\index{CholeskySolution@{CholeskySolution}!DMatrix@{DMatrix}}
\subsubsection[{CholeskySolution}]{\setlength{\rightskip}{0pt plus 5cm}void CholeskySolution (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{int}]{n, }
\item[{const {\bf DMatrix} \&}]{pM, }
\item[{const {\bf DMatrix} \&}]{bM, }
\item[{{\bf DMatrix} \&}]{xM}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ac66ec50116a7b447a9ba3d0cc38043eb}


Cholesky solution using the Cholesky decomposition of a matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em n} & is the number of columns of the input matrix A. \\
\hline
{\em pM} & \hyperlink{classDMatrix}{DMatrix} object which on output contains the Cholesky decomposition of input matrix a. \\
\hline
{\em bM} & \hyperlink{classDMatrix}{DMatrix} object with a vector of right-\/hand-\/side values \\
\hline
{\em xM} & (modified) \hyperlink{classDMatrix}{DMatrix} object which on return contains the solution to the system of equations \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_ae96d9db92ff5e3a72e0e7b0eda05490f}{CholeskyDecomp()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_ae5b99d9b1b937f38054ac8d16237b1c2}{
\index{DMatrix@{DMatrix}!CholFSolve@{CholFSolve}}
\index{CholFSolve@{CholFSolve}!DMatrix@{DMatrix}}
\subsubsection[{CholFSolve}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& CholFSolve (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{Achol, }
\item[{const {\bf DMatrix} \&}]{b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ae5b99d9b1b937f38054ac8d16237b1c2}


Solves the system of equations $ A x = b $ using Cholesky factorisation. The function uses a previously found Cholesky factorisation. 


\begin{DoxyParams}{Parameters}
{\em Achol} & is a \hyperlink{classDMatrix}{DMatrix} object resulting from a previous call to \hyperlink{classDMatrix_a1266502a32517e157a8a56a312e13b54}{Chol()}. \\
\hline
{\em b} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation (the resulting vector x) 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_ae5b99d9b1b937f38054ac8d16237b1c2}{CholFSolve()}, \hyperlink{classDMatrix_a1266502a32517e157a8a56a312e13b54}{Chol()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_a0167e219388b005d7b41ea3403191fd3}{
\index{DMatrix@{DMatrix}!CholSolve@{CholSolve}}
\index{CholSolve@{CholSolve}!DMatrix@{DMatrix}}
\subsubsection[{CholSolve}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& CholSolve (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a0167e219388b005d7b41ea3403191fd3}


Solves the system of equations $ A x = b $ using Cholesky factorisation. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em b} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation (the resulting vector x) 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_ae5b99d9b1b937f38054ac8d16237b1c2}{CholFSolve()}, \hyperlink{classDMatrix_a1266502a32517e157a8a56a312e13b54}{Chol()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_a2987194d90eec1f076a329414ac07278}{
\index{DMatrix@{DMatrix}!colon@{colon}}
\index{colon@{colon}!DMatrix@{DMatrix}}
\subsubsection[{colon}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& colon (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a2987194d90eec1f076a329414ac07278}


This function generates a special \hyperlink{classDMatrix}{DMatrix} object with one row and one column which is understood by the indexing functions that take a \hyperlink{classDMatrix}{DMatrix} object as an argument to mean \char`\"{}all rows\char`\"{} or \char`\"{}all columns\char`\"{}. 

\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_ab52a3e622e1d9bab78e860842f5dd983}{
\index{DMatrix@{DMatrix}!colon@{colon}}
\index{colon@{colon}!DMatrix@{DMatrix}}
\subsubsection[{colon}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& colon (
\begin{DoxyParamCaption}
\item[{double}]{i1, }
\item[{double}]{increment, }
\item[{double}]{i2}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ab52a3e622e1d9bab78e860842f5dd983}


This function generates a \hyperlink{classDMatrix}{DMatrix} object with a vector starting from a given value, with given increments and ending in a given value. 


\begin{DoxyParams}{Parameters}
{\em i1} & is the first value \\
\hline
{\em increment} & is the increment \\
\hline
{\em i2} & is the last value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad79d00fc58e2584963625ecf46ccabee}{
\index{DMatrix@{DMatrix}!colon@{colon}}
\index{colon@{colon}!DMatrix@{DMatrix}}
\subsubsection[{colon}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& colon (
\begin{DoxyParamCaption}
\item[{int}]{i1, }
\item[{int}]{increment, }
\item[{int}]{i2}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad79d00fc58e2584963625ecf46ccabee}


This function generates \hyperlink{classDMatrix}{DMatrix} object with a vector starting from a given value, with given increments and ending in a given value. 


\begin{DoxyParams}{Parameters}
{\em i1} & is the first value \\
\hline
{\em increment} & is the increment \\
\hline
{\em i2} & is the last value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a1cbcbb56a983edaa8e40dba43df831c0}{
\index{DMatrix@{DMatrix}!colon@{colon}}
\index{colon@{colon}!DMatrix@{DMatrix}}
\subsubsection[{colon}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& colon (
\begin{DoxyParamCaption}
\item[{int}]{i1, }
\item[{int}]{i2}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a1cbcbb56a983edaa8e40dba43df831c0}


This function generates \hyperlink{classDMatrix}{DMatrix} object with a vector starting from a given value, with unit increments, and ending in a given value. 


\begin{DoxyParams}{Parameters}
{\em i1} & is the first value \\
\hline
{\em i2} & is the last value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a1f79ebd6d8952d215f2792a9c19a0064}{
\index{DMatrix@{DMatrix}!colon@{colon}}
\index{colon@{colon}!DMatrix@{DMatrix}}
\subsubsection[{colon}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& colon (
\begin{DoxyParamCaption}
\item[{double}]{i1, }
\item[{double}]{i2}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a1f79ebd6d8952d215f2792a9c19a0064}


This function generates \hyperlink{classDMatrix}{DMatrix} object with a vector starting from a given value, with unit increments, and ending in a given value. 


\begin{DoxyParams}{Parameters}
{\em i1} & is the first value \\
\hline
{\em i2} & is the last value \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object 
\end{DoxyReturn}
\hypertarget{classDMatrix_a474926f74756b827c79b7127a84a4bb6}{
\index{DMatrix@{DMatrix}!cond@{cond}}
\index{cond@{cond}!DMatrix@{DMatrix}}
\subsubsection[{cond}]{\setlength{\rightskip}{0pt plus 5cm}double cond (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a474926f74756b827c79b7127a84a4bb6}


This function calculates the 2-\/norm condition number of a matrix, which is the ratio of the maximum singular value to the minimum singular value of the matrix. A large condition number indicates a nearly singular matrix. If the input matrix is not square, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the 2-\/norm condition number 
\end{DoxyReturn}
\hypertarget{classDMatrix_aa9e07c7b8674a182891bfaf4699906b9}{
\index{DMatrix@{DMatrix}!cos@{cos}}
\index{cos@{cos}!DMatrix@{DMatrix}}
\subsubsection[{cos}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& cos (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aa9e07c7b8674a182891bfaf4699906b9}


This function returns a matrix with the cosine of each element of the input matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a567d9f47845cd22715ad3d44e4644b40}{
\index{DMatrix@{DMatrix}!cosh@{cosh}}
\index{cosh@{cosh}!DMatrix@{DMatrix}}
\subsubsection[{cosh}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& cosh (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a567d9f47845cd22715ad3d44e4644b40}


This function returns a matrix with the hyperbolic cosine of each element of the input matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a261380c58f5a12770bdecf4c0d57eddb}{
\index{DMatrix@{DMatrix}!cov@{cov}}
\index{cov@{cov}!DMatrix@{DMatrix}}
\subsubsection[{cov}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& cov (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{int}]{ntype = {\ttfamily 0}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a261380c58f5a12770bdecf4c0d57eddb}


Computes the covariance matrix of a data matrix where the N rows correspond to samples and the M columns are variables. The result is returned as an M x M matrix. If ntype=0 (default) then the result is normalised with N-\/1. Otherwise, if ntype=1, the result is normalised with N. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em ntype} & is the type of normalization, 0 (default) or 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac4da4357ee63d240053aebfc8d687784}{
\index{DMatrix@{DMatrix}!cov@{cov}}
\index{cov@{cov}!DMatrix@{DMatrix}}
\subsubsection[{cov}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& cov (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} \&}]{X, }
\item[{{\bf DMatrix} \&}]{Y, }
\item[{int}]{ntype = {\ttfamily 0}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ac4da4357ee63d240053aebfc8d687784}


Computes the covariance matrix of two vectors X and Y of dimension N. The result is returned as an 1 x 1 \hyperlink{classDMatrix}{DMatrix} object. If ntype=0 (default) then the result is normalised with N-\/1. Otherwise, if ntype=1, the result is normalised with N. 


\begin{DoxyParams}{Parameters}
{\em X} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em Y} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em ntype} & is the type of normalization, 0 (default) or 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_aaf0cb02dcd852ce56ccb39d550fa7c0a}{
\index{DMatrix@{DMatrix}!cross@{cross}}
\index{cross@{cross}!DMatrix@{DMatrix}}
\subsubsection[{cross}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& cross (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{x, }
\item[{const {\bf DMatrix} \&}]{y}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aaf0cb02dcd852ce56ccb39d550fa7c0a}


This function computes the cross product of two vectors. If any of the input arguments does not contain a vector, or if the length of any of the vectors is not 3, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em x} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em y} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the cross product of x and y. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a824f640d88220c84f5b31d9ed191c8ba}{
\index{DMatrix@{DMatrix}!crossProduct@{crossProduct}}
\index{crossProduct@{crossProduct}!DMatrix@{DMatrix}}
\subsubsection[{crossProduct}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& crossProduct (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{x, }
\item[{const {\bf DMatrix} \&}]{y}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a824f640d88220c84f5b31d9ed191c8ba}


This function computes the cross product of two vectors. If any of the input arguments does not contain a vector, or if the length of any of the vectors is not 3, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em x} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em y} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the cross product of x and y. 
\end{DoxyReturn}
\hypertarget{classDMatrix_aafe913bbf754d4c204e4d09033de4ff5}{
\index{DMatrix@{DMatrix}!det@{det}}
\index{det@{det}!DMatrix@{DMatrix}}
\subsubsection[{det}]{\setlength{\rightskip}{0pt plus 5cm}double det (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aafe913bbf754d4c204e4d09033de4ff5}


This function returns the determinant of a square matrix. If the input matrix is not square, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the determinant of the matrix. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a417b7d2c566648bf891e5da105ba4233}{
\index{DMatrix@{DMatrix}!diag@{diag}}
\index{diag@{diag}!DMatrix@{DMatrix}}
\subsubsection[{diag}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& diag (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a417b7d2c566648bf891e5da105ba4233}


if A is a matrix this function extracts a column vector with the diagonal values of A. If A is a vector this function returns a matrix having the elements of A in the diagonal 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ae80c19e8c19de710f5790698e9568756}{
\index{DMatrix@{DMatrix}!dot@{dot}}
\index{dot@{dot}!DMatrix@{DMatrix}}
\subsubsection[{dot}]{\setlength{\rightskip}{0pt plus 5cm}double dot (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{x, }
\item[{const {\bf DMatrix} \&}]{y}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ae80c19e8c19de710f5790698e9568756}


This function computes the dot product of two vectors. If any of the input arguments does not contain a vector, or if the vector lengths are not equal, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em x} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em y} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the dot product of x and y. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a28b13c78f679925c43ba7743e4def95e}{
\index{DMatrix@{DMatrix}!dotProduct@{dotProduct}}
\index{dotProduct@{dotProduct}!DMatrix@{DMatrix}}
\subsubsection[{dotProduct}]{\setlength{\rightskip}{0pt plus 5cm}double dotProduct (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{x, }
\item[{const {\bf DMatrix} \&}]{y}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a28b13c78f679925c43ba7743e4def95e}


This function computes the dot product of two vectors. If any of the input arguments does not contain a vector, or if the vector lengths are not equal, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em x} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em y} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the dot product of x and y. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a160797dd45b601c20b26ad4c189fe8f2}{
\index{DMatrix@{DMatrix}!eig@{eig}}
\index{eig@{eig}!DMatrix@{DMatrix}}
\subsubsection[{eig}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& eig (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{{\bf DMatrix} $\ast$}]{V = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a160797dd45b601c20b26ad4c189fe8f2}


This function computes the eigenvalues and (optionally) the eigenvectors of a matrix A. This function uses the LAPACK routines dsyev\_\-() and dgeev\_\-. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em V} & is a pointer to a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the real part of the eigenvalues in the first column and the complex part of the eigenvalues in the second column. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a7d66bf14f6c28485a886ece99589d366}{
\index{DMatrix@{DMatrix}!elemDivision@{elemDivision}}
\index{elemDivision@{elemDivision}!DMatrix@{DMatrix}}
\subsubsection[{elemDivision}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& elemDivision (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a7d66bf14f6c28485a886ece99589d366}


This function computes and returns the element-\/wise division of two matrices of the same dimensions. If the dimensions of the two input matrices are not the same, an error is thrown. The dimensions of the returned object are the same as the dimensions of the factors. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a4fcfc361ca88cbbf21c89c50eca932d8}{
\index{DMatrix@{DMatrix}!elemProduct@{elemProduct}}
\index{elemProduct@{elemProduct}!DMatrix@{DMatrix}}
\subsubsection[{elemProduct}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& elemProduct (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a4fcfc361ca88cbbf21c89c50eca932d8}


This function computes and returns the element-\/wise product of two matrices of the same dimensions. If the dimensions of the two input matrices are not the same, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_aafa519c3dd4bd2b69731ef2fef01a371}{
\index{DMatrix@{DMatrix}!enorm@{enorm}}
\index{enorm@{enorm}!DMatrix@{DMatrix}}
\subsubsection[{enorm}]{\setlength{\rightskip}{0pt plus 5cm}double enorm (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aafa519c3dd4bd2b69731ef2fef01a371}


This function computes and return the Euclidean norm of a matrix A, which is the square root of the sum of its squared elements. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the Euclidean norm. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6067456d71764a846f24a141e77d00f3}{
\index{DMatrix@{DMatrix}!error\_\-message@{error\_\-message}}
\index{error\_\-message@{error\_\-message}!DMatrix@{DMatrix}}
\subsubsection[{error\_\-message}]{\setlength{\rightskip}{0pt plus 5cm}void error\_\-message (
\begin{DoxyParamCaption}
\item[{const char $\ast$}]{input\_\-text}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a6067456d71764a846f24a141e77d00f3}


This function prints an error message and throws an exception to be handled by the \hyperlink{classErrorHandler}{ErrorHandler} class. 


\begin{DoxyParams}{Parameters}
{\em input\_\-text} & is the error message \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_a16013e5264442d52b6d98a4a49fee29f}{
\index{DMatrix@{DMatrix}!exp@{exp}}
\index{exp@{exp}!DMatrix@{DMatrix}}
\subsubsection[{exp}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& exp (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a16013e5264442d52b6d98a4a49fee29f}


This function returns a matrix with the natural exponential of each element of the input matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a0cbd806dab65e5458cb5ad832615c506}{
\index{DMatrix@{DMatrix}!expm@{expm}}
\index{expm@{expm}!DMatrix@{DMatrix}}
\subsubsection[{expm}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& expm (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a0cbd806dab65e5458cb5ad832615c506}


This function returns the exponential matrix of a given square matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_aafc7c944155ff0404f3201ce8b764bea}{
\index{DMatrix@{DMatrix}!eye@{eye}}
\index{eye@{eye}!DMatrix@{DMatrix}}
\subsubsection[{eye}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& eye (
\begin{DoxyParamCaption}
\item[{long}]{n}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aafc7c944155ff0404f3201ce8b764bea}


This function returns the identity matrix with a given number of rows and columns. 


\begin{DoxyParams}{Parameters}
{\em n} & is the desired number of rows and columns \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_aee7a643a65d88ae71a19462563fb9805}{
\index{DMatrix@{DMatrix}!eye@{eye}}
\index{eye@{eye}!DMatrix@{DMatrix}}
\subsubsection[{eye}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& eye (
\begin{DoxyParamCaption}
\item[{long}]{n, }
\item[{long}]{m}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aee7a643a65d88ae71a19462563fb9805}


This function returns a truncated identity matrix with specified numbers of rows and columns. 


\begin{DoxyParams}{Parameters}
{\em n} & is the desired number of rows \\
\hline
{\em m} & is the desired number of columns \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_addd401503db0026290c74a9ae860ba6a}{
\index{DMatrix@{DMatrix}!find@{find}}
\index{find@{find}!DMatrix@{DMatrix}}
\subsubsection[{find}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& find (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_addd401503db0026290c74a9ae860ba6a}


This function returns a column vector with the linear indices of the non-\/zero elements of the input matrix A. The linear index is 1 for element (1,1) of the input matrix A, and length(A) for the (nrows,ncols) element of the input matrix A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a650d19963c7ca65fe5e8f58c08fc3e55}{
\index{DMatrix@{DMatrix}!Fnorm@{Fnorm}}
\index{Fnorm@{Fnorm}!DMatrix@{DMatrix}}
\subsubsection[{Fnorm}]{\setlength{\rightskip}{0pt plus 5cm}double Fnorm (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a650d19963c7ca65fe5e8f58c08fc3e55}


This function computes Frobenius norm of matrix A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the Frobenius norm 
\end{DoxyReturn}
\hypertarget{classDMatrix_ab54dc58f34aa18e7ff82b21b3533b173}{
\index{DMatrix@{DMatrix}!identity@{identity}}
\index{identity@{identity}!DMatrix@{DMatrix}}
\subsubsection[{identity}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& identity (
\begin{DoxyParamCaption}
\item[{long}]{n, }
\item[{long}]{m}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ab54dc58f34aa18e7ff82b21b3533b173}


This function returns a truncated identity matrix with specified numbers of rows and columns. 


\begin{DoxyParams}{Parameters}
{\em n} & is the desired number of rows \\
\hline
{\em m} & is the desired number of columns \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac33c390deeaf029a44055773fa06bd00}{
\index{DMatrix@{DMatrix}!identity@{identity}}
\index{identity@{identity}!DMatrix@{DMatrix}}
\subsubsection[{identity}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& identity (
\begin{DoxyParamCaption}
\item[{long}]{n}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ac33c390deeaf029a44055773fa06bd00}


This function returns the identity matrix with a given number of rows and columns. 


\begin{DoxyParams}{Parameters}
{\em n} & is the desired number of rows and columns \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_afc6bf998f40686caf55730b53cea7150}{
\index{DMatrix@{DMatrix}!InfNorm@{InfNorm}}
\index{InfNorm@{InfNorm}!DMatrix@{DMatrix}}
\subsubsection[{InfNorm}]{\setlength{\rightskip}{0pt plus 5cm}double InfNorm (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_afc6bf998f40686caf55730b53cea7150}


This function computes infinity norm of matrix A, which is computed as the maximum absolute value row sum. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the infinity norm 
\end{DoxyReturn}
\hypertarget{classDMatrix_a322373e24822a8633c2ddfd8f7397c11}{
\index{DMatrix@{DMatrix}!inv@{inv}}
\index{inv@{inv}!DMatrix@{DMatrix}}
\subsubsection[{inv}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& inv (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a322373e24822a8633c2ddfd8f7397c11}


This function returns the inverse of a given square matrix. If the argument is not a square matrix an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad31c97e930c0fdc797ecd165f251fc27}{
\index{DMatrix@{DMatrix}!isSymmetric@{isSymmetric}}
\index{isSymmetric@{isSymmetric}!DMatrix@{DMatrix}}
\subsubsection[{isSymmetric}]{\setlength{\rightskip}{0pt plus 5cm}int isSymmetric (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad31c97e930c0fdc797ecd165f251fc27}


This function checks if the input matrix is symmetric. If the input matrix is not square, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
1 if the input matrix is symmetric, 0 otherwise. 
\end{DoxyReturn}
\hypertarget{classDMatrix_adc052c1c9f76c909347b83f662fb5952}{
\index{DMatrix@{DMatrix}!kronProduct@{kronProduct}}
\index{kronProduct@{kronProduct}!DMatrix@{DMatrix}}
\subsubsection[{kronProduct}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& kronProduct (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_adc052c1c9f76c909347b83f662fb5952}


This function computes and returns the Kronecker product of two matrices. The row (column) dimension of the returned object is the product of the row (column) dimensions of both factors. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a416133f8c3a457e0997f7f387697be62}{
\index{DMatrix@{DMatrix}!length@{length}}
\index{length@{length}!DMatrix@{DMatrix}}
\subsubsection[{length}]{\setlength{\rightskip}{0pt plus 5cm}long length (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a416133f8c3a457e0997f7f387697be62}


This function returns the number of elements of a matrix A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the number of elements of the input matrix. 
\end{DoxyReturn}
\hypertarget{classDMatrix_aa3d52614c6e5b34caff46a462af5e48c}{
\index{DMatrix@{DMatrix}!linspace@{linspace}}
\index{linspace@{linspace}!DMatrix@{DMatrix}}
\subsubsection[{linspace}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& linspace (
\begin{DoxyParamCaption}
\item[{double}]{X1, }
\item[{double}]{X2, }
\item[{long}]{N}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aa3d52614c6e5b34caff46a462af5e48c}


This function returns a linearly spaced vector with N points between the values X1 and X2. 


\begin{DoxyParams}{Parameters}
{\em X1} & is a real number \\
\hline
{\em X2} & is a real number \\
\hline
{\em N} & is the desired length of the returned vector \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a75ca121105b6022b5cff058be162f209}{
\index{DMatrix@{DMatrix}!log@{log}}
\index{log@{log}!DMatrix@{DMatrix}}
\subsubsection[{log}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& log (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a75ca121105b6022b5cff058be162f209}


This function returns a matrix with the natural logarithm of each element of the input matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a1ccd9a0ef8a37d739b31e85f84c2743c}{
\index{DMatrix@{DMatrix}!LQ@{LQ}}
\index{LQ@{LQ}!DMatrix@{DMatrix}}
\subsubsection[{LQ}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& LQ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{{\bf DMatrix} $\ast$}]{Q}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a1ccd9a0ef8a37d739b31e85f84c2743c}


Returns the LQ factorisation of a matrix A. The function uses the LAPACK routine dgelqf\_\-(). 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object· \\
\hline
{\em Q} & is a pointer to a \hyperlink{classDMatrix}{DMatrix} object, which is modified on output to contain the Q factor of the decomposition. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the L factor of the decomposition. 
\end{DoxyReturn}
\hypertarget{classDMatrix_aba0583d31407f78cfe1176d74d03fa59}{
\index{DMatrix@{DMatrix}!LSMNSolve@{LSMNSolve}}
\index{LSMNSolve@{LSMNSolve}!DMatrix@{DMatrix}}
\subsubsection[{LSMNSolve}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& LSMNSolve (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aba0583d31407f78cfe1176d74d03fa59}


This function solves overdetermined or underdetermined real linear systems $ A x = B $ using a QR or LQ factorization of A. It is assumed that matrix A has full rank. The function uses the LAPACK routine dgels. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation (the resulting vector x) 
\end{DoxyReturn}
\hypertarget{classDMatrix_a71dd04fdd14b319042752e184ded3393}{
\index{DMatrix@{DMatrix}!LU@{LU}}
\index{LU@{LU}!DMatrix@{DMatrix}}
\subsubsection[{LU}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& LU (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a71dd04fdd14b319042752e184ded3393}


Returns the LU factorisation of a matrix A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object· \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_ad9133e1f6215a490287e1f0b262c5212}{LUFSolve()}, \hyperlink{classDMatrix_aebb97348d6f64a5a77e6b0a5bcfa3afb}{LUSolve()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_ad9133e1f6215a490287e1f0b262c5212}{
\index{DMatrix@{DMatrix}!LUFSolve@{LUFSolve}}
\index{LUFSolve@{LUFSolve}!DMatrix@{DMatrix}}
\subsubsection[{LUFSolve}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& LUFSolve (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{ALU, }
\item[{const {\bf DMatrix} \&}]{b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad9133e1f6215a490287e1f0b262c5212}


Solves the system of equations $ A x = b $ using LU factorisation using a previously found LU factors. 


\begin{DoxyParams}{Parameters}
{\em ALU} & is a \hyperlink{classDMatrix}{DMatrix} object resulting from a previous call to the \hyperlink{classDMatrix_a71dd04fdd14b319042752e184ded3393}{LU()} function \\
\hline
{\em b} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation (the resulting vector x) 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_a71dd04fdd14b319042752e184ded3393}{LU()}, \hyperlink{classDMatrix_aebb97348d6f64a5a77e6b0a5bcfa3afb}{LUSolve()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_aebb97348d6f64a5a77e6b0a5bcfa3afb}{
\index{DMatrix@{DMatrix}!LUSolve@{LUSolve}}
\index{LUSolve@{LUSolve}!DMatrix@{DMatrix}}
\subsubsection[{LUSolve}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& LUSolve (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aebb97348d6f64a5a77e6b0a5bcfa3afb}


Solves the system of equations $ A x = b $ using LU factorisation. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em b} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation (the resulting vector x) 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_ad9133e1f6215a490287e1f0b262c5212}{LUFSolve()}, \hyperlink{classDMatrix_a71dd04fdd14b319042752e184ded3393}{LU()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_a5fef948be5e07507f9e0c9cc11e6cd09}{
\index{DMatrix@{DMatrix}!MatrixSign@{MatrixSign}}
\index{MatrixSign@{MatrixSign}!DMatrix@{DMatrix}}
\subsubsection[{MatrixSign}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& MatrixSign (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a5fef948be5e07507f9e0c9cc11e6cd09}


This function returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions as the input matrix such that each of its elements is 1 is the corresponding value of the input matrix is positive, -\/1 if the corresponding value of the input matrix is negative, and 0 if the corresponding value of the input matrix is 0. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a734ba2f493c1e69b72dfaf09cfdc1224}{
\index{DMatrix@{DMatrix}!Max@{Max}}
\index{Max@{Max}!DMatrix@{DMatrix}}
\subsubsection[{Max}]{\setlength{\rightskip}{0pt plus 5cm}double Max (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{int $\ast$}]{rindx = {\ttfamily NULL}, }
\item[{int $\ast$}]{cindx = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a734ba2f493c1e69b72dfaf09cfdc1224}


This function finds and returns the element of matrix A with maximum value. It also returns the indices of such element. If more than one element has the same maximum value, the indices of the first element found when searching column by column is returned. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em rindx} & is an optional pointer to an integer which is modified with the row index. \\
\hline
{\em cindx} & is an optional pointer to an integer which is modified with the column index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the element with maximum value. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6bd64bff4bf5dea949448371d9e34c14}{
\index{DMatrix@{DMatrix}!MaxAbs@{MaxAbs}}
\index{MaxAbs@{MaxAbs}!DMatrix@{DMatrix}}
\subsubsection[{MaxAbs}]{\setlength{\rightskip}{0pt plus 5cm}double MaxAbs (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{int $\ast$}]{rindx = {\ttfamily NULL}, }
\item[{int $\ast$}]{cindx = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a6bd64bff4bf5dea949448371d9e34c14}


This function finds and returns the element of matrix A with maximum absolute value. It also returns the indices of such element. If more than one element has the same maximum absolute value, the indices of the first element found when searching column by column is returned. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em rindx} & is a pointer to an integer which is modified with the row index. \\
\hline
{\em cindx} & is a pointer to an integer which is modified with the column index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the absolute value of the element with maximum absolute value. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a210dc48c90f3be6b71e35784b3625633}{
\index{DMatrix@{DMatrix}!mean@{mean}}
\index{mean@{mean}!DMatrix@{DMatrix}}
\subsubsection[{mean}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& mean (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a210dc48c90f3be6b71e35784b3625633}


This function returns a row vector with the mean values of the columns of matrix A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6168ace6eec6c2c1724638a1e4c1059c}{
\index{DMatrix@{DMatrix}!Min@{Min}}
\index{Min@{Min}!DMatrix@{DMatrix}}
\subsubsection[{Min}]{\setlength{\rightskip}{0pt plus 5cm}double Min (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{int $\ast$}]{rindx = {\ttfamily NULL}, }
\item[{int $\ast$}]{cindx = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a6168ace6eec6c2c1724638a1e4c1059c}


This function finds and returns the element of matrix A with minimum value. It also returns the indices of such element. If more than one element has the same minimum value, the indices of the first element found when searching column by column is returned. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em rindx} & is a pointer to an integer which is modified with the row index. \\
\hline
{\em cindx} & is a pointer to an integer which is modified with the column index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the absolute value of the element with minimum absolute value. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a8a3779432dbf1db00faf44079f9a4129}{
\index{DMatrix@{DMatrix}!MinAbs@{MinAbs}}
\index{MinAbs@{MinAbs}!DMatrix@{DMatrix}}
\subsubsection[{MinAbs}]{\setlength{\rightskip}{0pt plus 5cm}double MinAbs (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{int $\ast$}]{rindx = {\ttfamily NULL}, }
\item[{int $\ast$}]{cindx = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a8a3779432dbf1db00faf44079f9a4129}


This function finds and returns the element of matrix A with minimum absolute value. It also returns the indices of such element. If more than one element has the same minimum absolute value, the indices of the first element found when searching column by column is returned. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em rindx} & is a pointer to an integer which is modified with the row index. \\
\hline
{\em cindx} & is a pointer to an integer which is modified with the column index. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the absolute value of the element with minimum absolute value. 
\end{DoxyReturn}
\hypertarget{classDMatrix_aed1822acbc4a807359a836ab57386d07}{
\index{DMatrix@{DMatrix}!mpow@{mpow}}
\index{mpow@{mpow}!DMatrix@{DMatrix}}
\subsubsection[{mpow}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& mpow (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} \&}]{A, }
\item[{int}]{p}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_aed1822acbc4a807359a836ab57386d07}


This function calculates the integer matrix power. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em p} & is an integer value which can be positive or negative \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a5169a4190b500841d156828863e414c8}{
\index{DMatrix@{DMatrix}!norm@{norm}}
\index{norm@{norm}!DMatrix@{DMatrix}}
\subsubsection[{norm}]{\setlength{\rightskip}{0pt plus 5cm}double norm (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a5169a4190b500841d156828863e414c8}


This function computes 2-\/norm of matrix A, which is computed as the maximum singular value of A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the value of the 2-\/norm 
\end{DoxyReturn}
\hypertarget{classDMatrix_a038aceaf8588f3f7743562f598cab15d}{
\index{DMatrix@{DMatrix}!null@{null}}
\index{null@{null}!DMatrix@{DMatrix}}
\subsubsection[{null}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& null (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a038aceaf8588f3f7743562f598cab15d}


This function returns Z, the orthonormal basis for the null space of a matrix A, such that $ Z Z' = I $ and $ A Z=0 $. The number of columns of Z is the nullity of A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad90074f7636d5a5a80de596f210b398c}{
\index{DMatrix@{DMatrix}!ones@{ones}}
\index{ones@{ones}!DMatrix@{DMatrix}}
\subsubsection[{ones}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& ones (
\begin{DoxyParamCaption}
\item[{long}]{n, }
\item[{long}]{m}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad90074f7636d5a5a80de596f210b398c}


This function returns a matrix full of ones with specified numbers of rows and columns. 


\begin{DoxyParams}{Parameters}
{\em n} & is the desired number of rows \\
\hline
{\em m} & is the desired number of columns \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_abf562762c4dfe45f93d14976001bc61e}{
\index{DMatrix@{DMatrix}!operator$\ast$@{operator$\ast$}}
\index{operator$\ast$@{operator$\ast$}!DMatrix@{DMatrix}}
\subsubsection[{operator$\ast$}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& operator$\ast$ (
\begin{DoxyParamCaption}
\item[{double}]{r, }
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_abf562762c4dfe45f93d14976001bc61e}


This function multiplies a real number by a matrix. 


\begin{DoxyParams}{Parameters}
{\em r} & is a double value \\
\hline
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ac100c02f140686e07a7b520bf5a58e25}{
\index{DMatrix@{DMatrix}!operator-\/@{operator-\/}}
\index{operator-\/@{operator-\/}!DMatrix@{DMatrix}}
\subsubsection[{operator-\/}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& operator-\/ (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ac100c02f140686e07a7b520bf5a58e25}


Matrix unary minus operator. Returns an object of the same dimensions as A but with changed element signs. 


\begin{DoxyParams}{Parameters}
{\em A,:} & matrix located at the right hand side of the operator. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad80782cbeec0075aeaa43fc2e2264cc0}{
\index{DMatrix@{DMatrix}!orth@{orth}}
\index{orth@{orth}!DMatrix@{DMatrix}}
\subsubsection[{orth}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& orth (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad80782cbeec0075aeaa43fc2e2264cc0}


This function returns Q, the orthonormal basis for the range of a matrix A, such that $ Q Q' = I $. The number of columns of Q is the rank of A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a07480acdabc192269bf2fceb56eb2ef4}{
\index{DMatrix@{DMatrix}!pinv@{pinv}}
\index{pinv@{pinv}!DMatrix@{DMatrix}}
\subsubsection[{pinv}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& pinv (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a07480acdabc192269bf2fceb56eb2ef4}


This function returns the pseudo-\/inverse of a given rectangular matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6cec987fa2c6fb5fb22aaa07e647adba}{
\index{DMatrix@{DMatrix}!prod@{prod}}
\index{prod@{prod}!DMatrix@{DMatrix}}
\subsubsection[{prod}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& prod (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a6cec987fa2c6fb5fb22aaa07e647adba}


This function returns a row vector with the product of the elements of each column of matrix A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a4d51f780b4a609cd73c6c6b9b2ff1884}{
\index{DMatrix@{DMatrix}!Product@{Product}}
\index{Product@{Product}!DMatrix@{DMatrix}}
\subsubsection[{Product}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& Product (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a4d51f780b4a609cd73c6c6b9b2ff1884}


This function calculates the product of two matrices. The number of columns of the first matrix must be the same as the number of rows of the second matrix, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad77d1a08b972e1cbba7bb60b7ea20bf1}{
\index{DMatrix@{DMatrix}!ProductT@{ProductT}}
\index{ProductT@{ProductT}!DMatrix@{DMatrix}}
\subsubsection[{ProductT}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& ProductT (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad77d1a08b972e1cbba7bb60b7ea20bf1}


This function returns the product of the first matrix times the second matrix transposed. The number of columns of both matrices must be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a31d884a31b9ef5b534de344af01e2a38}{
\index{DMatrix@{DMatrix}!QR@{QR}}
\index{QR@{QR}!DMatrix@{DMatrix}}
\subsubsection[{QR}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& QR (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a31d884a31b9ef5b534de344af01e2a38}


Returns the QR factorisation of a matrix A. The number of rows of matrix A must be greater or equal than the number of columns. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object· \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_a3a0e406e05efdd9374cc918645053b27}{QRFSolve()}, \hyperlink{classDMatrix_a3b4d3e101ff20bd05a1908437481bef0}{QRSolve()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_a3a0e406e05efdd9374cc918645053b27}{
\index{DMatrix@{DMatrix}!QRFSolve@{QRFSolve}}
\index{QRFSolve@{QRFSolve}!DMatrix@{DMatrix}}
\subsubsection[{QRFSolve}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& QRFSolve (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a3a0e406e05efdd9374cc918645053b27}


Solves the system of equations $ A x = b $ using QR factorisation. The function uses a previously found QR factorisation. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em b} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation (the resulting vector x) 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_a3b4d3e101ff20bd05a1908437481bef0}{QRSolve()}, \hyperlink{classDMatrix_a31d884a31b9ef5b534de344af01e2a38}{QR()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_a3b4d3e101ff20bd05a1908437481bef0}{
\index{DMatrix@{DMatrix}!QRSolve@{QRSolve}}
\index{QRSolve@{QRSolve}!DMatrix@{DMatrix}}
\subsubsection[{QRSolve}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& QRSolve (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{b}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a3b4d3e101ff20bd05a1908437481bef0}


Solves the system of equations $ A x = b $ using QR factorisation. The number of rows of matrix A must be greater or equal than the number of columns. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em b} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation (the resulting vector x) 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_a3a0e406e05efdd9374cc918645053b27}{QRFSolve()}, \hyperlink{classDMatrix_a31d884a31b9ef5b534de344af01e2a38}{QR()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_a4bc7a80762269f95de50605fc87f0223}{
\index{DMatrix@{DMatrix}!randn@{randn}}
\index{randn@{randn}!DMatrix@{DMatrix}}
\subsubsection[{randn}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& randn (
\begin{DoxyParamCaption}
\item[{long}]{n, }
\item[{long}]{m}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a4bc7a80762269f95de50605fc87f0223}


This function returns an nxm matrix where each element is a Gaussian pseudo-\/random number in the range with zero mean and variance 1. 


\begin{DoxyParams}{Parameters}
{\em n} & is the desired number of rows of the returned matrix \\
\hline
{\em m} & is the desired number of columns of the returned matrix \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a299e165ca173181d5efb78a2098f742c}{
\index{DMatrix@{DMatrix}!randu@{randu}}
\index{randu@{randu}!DMatrix@{DMatrix}}
\subsubsection[{randu}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& randu (
\begin{DoxyParamCaption}
\item[{long}]{n, }
\item[{long}]{m}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a299e165ca173181d5efb78a2098f742c}


This function returns an nxm matrix where each element is a uniform pseudo-\/random number in the range (0,1). 


\begin{DoxyParams}{Parameters}
{\em n} & is the desired number of rows of the returned matrix \\
\hline
{\em m} & is the desired number of columns of the returned matrix \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a5379bc44e75307fc4f0242ef196ca2c8}{
\index{DMatrix@{DMatrix}!rank@{rank}}
\index{rank@{rank}!DMatrix@{DMatrix}}
\subsubsection[{rank}]{\setlength{\rightskip}{0pt plus 5cm}int rank (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a5379bc44e75307fc4f0242ef196ca2c8}


This function returns an estimate of the rank of a matrix, which is the number of linearly independent rows or columns. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the rank estimate. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a5421e6760accac0eefb83d4a604e0612}{
\index{DMatrix@{DMatrix}!rcond@{rcond}}
\index{rcond@{rcond}!DMatrix@{DMatrix}}
\subsubsection[{rcond}]{\setlength{\rightskip}{0pt plus 5cm}double rcond (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a5421e6760accac0eefb83d4a604e0612}


This function estimates the 1-\/norm reciprocal condition number of a matrix. The function uses the LAPACK function dgecon. if A is well conditioned, then rcond(A) is near 1. If A is badly conditioned, then rcond(A) is close to the machine numerical precision (very small). If the input matrix is not square, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the reciprocal condition number estimate 
\end{DoxyReturn}
\hypertarget{classDMatrix_ae626fae47c554940c8384933c6ca1e9f}{
\index{DMatrix@{DMatrix}!reshape@{reshape}}
\index{reshape@{reshape}!DMatrix@{DMatrix}}
\subsubsection[{reshape}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& reshape (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} \&}]{A, }
\item[{long}]{N, }
\item[{long}]{M}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ae626fae47c554940c8384933c6ca1e9f}


This function returns the N-\/by-\/M matrix whose elements are taken columnwise from the input matrix A. An error is thrown if A does not have N$\ast$M elements. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em N} & is the desired number of rows of the reshaped matrix \\
\hline
{\em M} & is the desired number of columns of the reshaped matrix \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a2dfbc15150a97456fefdd9d23b1e0932}{
\index{DMatrix@{DMatrix}!schur@{schur}}
\index{schur@{schur}!DMatrix@{DMatrix}}
\subsubsection[{schur}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& schur (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{{\bf DMatrix} $\ast$}]{U = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a2dfbc15150a97456fefdd9d23b1e0932}


This function computes and returns the Schur decomposition of a matrix A, such that $ A=Q'U Q $, where U is an upper triangular matrix and Q is a unitary matrix. This function uses the LAPACK routine dgees\_\-() 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em U} & is a pointer to a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the unitary matrix Q. 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad7d82c1616fcc97e403e50a5066ec851}{
\index{DMatrix@{DMatrix}!sin@{sin}}
\index{sin@{sin}!DMatrix@{DMatrix}}
\subsubsection[{sin}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& sin (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad7d82c1616fcc97e403e50a5066ec851}


This function returns a matrix with the sine of each element of the input matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6b8bfbf386b29e7333e14e4e6d894608}{
\index{DMatrix@{DMatrix}!sinh@{sinh}}
\index{sinh@{sinh}!DMatrix@{DMatrix}}
\subsubsection[{sinh}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& sinh (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a6b8bfbf386b29e7333e14e4e6d894608}


This function returns a matrix with the hyperbolic sine of each element of the input matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a6b5be996dbe79c22b1a6d616644a1b73}{
\index{DMatrix@{DMatrix}!sort@{sort}}
\index{sort@{sort}!DMatrix@{DMatrix}}
\subsubsection[{sort}]{\setlength{\rightskip}{0pt plus 5cm}void sort (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} \&}]{x, }
\item[{{\bf DMatrix} \&}]{indx}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a6b5be996dbe79c22b1a6d616644a1b73}


This function sorts the input vector x in ascending order. It also returns a \hyperlink{classDMatrix}{DMatrix} object with the sorted indices. If the input object is not a vector, then an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em x} & is a \hyperlink{classDMatrix}{DMatrix} object which upon input contains the unsorted vector and upon output contains the sorted vector. \\
\hline
{\em indx} & is a \hyperlink{classDMatrix}{DMatrix} object which upon output contains the values of the sorted indices. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_ad77fbdfed1b98748e430e4efc2c91856}{
\index{DMatrix@{DMatrix}!sort@{sort}}
\index{sort@{sort}!DMatrix@{DMatrix}}
\subsubsection[{sort}]{\setlength{\rightskip}{0pt plus 5cm}void sort (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} \&}]{x, }
\item[{int}]{indx\mbox{[}$\,$\mbox{]} = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ad77fbdfed1b98748e430e4efc2c91856}


This function sorts the input vector x in ascending order. Optionally, it also returns an integer array of sorted indices. If the input object is not a vector, then an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em x} & is a \hyperlink{classDMatrix}{DMatrix} object which upon input contains the unsorted vector and upon output contains the sorted vector. \\
\hline
{\em indx} & is a pointer to the first element of the array of sorted indices. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
void 
\end{DoxyReturn}
\hypertarget{classDMatrix_ae2a60a1294685079c39ea189bacdb4d2}{
\index{DMatrix@{DMatrix}!Sqrt@{Sqrt}}
\index{Sqrt@{Sqrt}!DMatrix@{DMatrix}}
\subsubsection[{Sqrt}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& Sqrt (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ae2a60a1294685079c39ea189bacdb4d2}


This function computes the square root of each element of the input matrix A, and it returns a \hyperlink{classDMatrix}{DMatrix} object with the same dimensions as the input matrix. If any element of the input matrix is negative, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a7c163993971bbf77eb42200e73061eee}{
\index{DMatrix@{DMatrix}!Std@{Std}}
\index{Std@{Std}!DMatrix@{DMatrix}}
\subsubsection[{Std}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& Std (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{int}]{ntype = {\ttfamily 0}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a7c163993971bbf77eb42200e73061eee}


This function returns a row vector with the standard deviation of each column of matrix A. If ntype is 0 (default) the result is normalised with (n-\/1), where n is the number of rows of A. Otherwise, the result is normalised with n. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em ntype} & is the type of normalization, 0 (default) or 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a7c0db4e6107794b51335d3c767a9cb55}{
\index{DMatrix@{DMatrix}!sum@{sum}}
\index{sum@{sum}!DMatrix@{DMatrix}}
\subsubsection[{sum}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& sum (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a7c0db4e6107794b51335d3c767a9cb55}


This function returns a row vector with the sum of the elements of each column of matrix A. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_afb39cb034e5bef5e4e416a22d53afb56}{
\index{DMatrix@{DMatrix}!SVD@{SVD}}
\index{SVD@{SVD}!DMatrix@{DMatrix}}
\subsubsection[{SVD}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& SVD (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{{\bf DMatrix} $\ast$}]{U = {\ttfamily NULL}, }
\item[{{\bf DMatrix} $\ast$}]{V = {\ttfamily NULL}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_afb39cb034e5bef5e4e416a22d53afb56}


Returns the singular value decomposition of a matrix $ A = U' diag(s) V $, where vector s contains the singular values of A. The function uses the LAPACK routine dgesvd\_\-(). 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object· \\
\hline
{\em U} & is a pointer to a \hyperlink{classDMatrix}{DMatrix} object, which is modified on output to contain the U factor of the decomposition. \\
\hline
{\em V} & is a pointer to a \hyperlink{classDMatrix}{DMatrix} object, which is modified on output to contain the V factor of the decomposition. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with a vector that contains the singular values of matrix A. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a13a156103ead07b546c81e6bdd366280}{
\index{DMatrix@{DMatrix}!SVDSolve@{SVDSolve}}
\index{SVDSolve@{SVDSolve}!DMatrix@{DMatrix}}
\subsubsection[{SVDSolve}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& SVDSolve (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a13a156103ead07b546c81e6bdd366280}


This function uses the LAPACK routine dgelss\_\-() to compute the minimum norm solution to a real linear least squares problem: Minimize $ || B - A x ||_2 $ using the singular value decomposition (SVD) of A. A is a rectangular matrix which may be rank-\/deficient. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation (the resulting vector x) 
\end{DoxyReturn}
\begin{DoxySeeAlso}{See also}
\hyperlink{classDMatrix_afb39cb034e5bef5e4e416a22d53afb56}{SVD()} 
\end{DoxySeeAlso}
\hypertarget{classDMatrix_a60601de2de5f8d857668cca1cea050e5}{
\index{DMatrix@{DMatrix}!tan@{tan}}
\index{tan@{tan}!DMatrix@{DMatrix}}
\subsubsection[{tan}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& tan (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a60601de2de5f8d857668cca1cea050e5}


This function returns a matrix with the tangent of each element of the input matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a524a9c2858469d68aac6a342eac2198a}{
\index{DMatrix@{DMatrix}!tanh@{tanh}}
\index{tanh@{tanh}!DMatrix@{DMatrix}}
\subsubsection[{tanh}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& tanh (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a524a9c2858469d68aac6a342eac2198a}


This function returns a matrix with the hyperbolic tangent of each element of the input matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a38664cf3d259198ae1e644736aa5e70e}{
\index{DMatrix@{DMatrix}!toc@{toc}}
\index{toc@{toc}!DMatrix@{DMatrix}}
\subsubsection[{toc}]{\setlength{\rightskip}{0pt plus 5cm}double toc (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a38664cf3d259198ae1e644736aa5e70e}


This function, which is to be used in conjunction with function \hyperlink{classDMatrix_ace51fd7d8435f88c8b2b3bcf64367673}{tic()}, stops counting CPU time, and it prints and returns the elapsed time in seconds since the function \hyperlink{classDMatrix_ace51fd7d8435f88c8b2b3bcf64367673}{tic()} was called. 

\begin{DoxyReturn}{Returns}
the elapsed time in seconds. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a36fc8f1174ba00e793bd88142dc11b9f}{
\index{DMatrix@{DMatrix}!TProduct@{TProduct}}
\index{TProduct@{TProduct}!DMatrix@{DMatrix}}
\subsubsection[{TProduct}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& TProduct (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a36fc8f1174ba00e793bd88142dc11b9f}


This function returns the product of the first matrix transposed times the second matrix. The number of rows of both matrices must be the same, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_acf0028536903ebb3dc83f1a83b20165c}{
\index{DMatrix@{DMatrix}!TProductT@{TProductT}}
\index{TProductT@{TProductT}!DMatrix@{DMatrix}}
\subsubsection[{TProductT}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& TProductT (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A, }
\item[{const {\bf DMatrix} \&}]{B}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_acf0028536903ebb3dc83f1a83b20165c}


This function returns the product of the first matrix transposed times the second matrix transposed. The number of rows of the first matrix must be the same as the number of columns of the second matrix, otherwise an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
{\em B} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_ada53ba13afcbd8b7e0916c3275839a85}{
\index{DMatrix@{DMatrix}!tra@{tra}}
\index{tra@{tra}!DMatrix@{DMatrix}}
\subsubsection[{tra}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& tra (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_ada53ba13afcbd8b7e0916c3275839a85}


This function returns the transpose of a given matrix. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a25e61176fea3c03f41f8a4524a3a08b0}{
\index{DMatrix@{DMatrix}!trace@{trace}}
\index{trace@{trace}!DMatrix@{DMatrix}}
\subsubsection[{trace}]{\setlength{\rightskip}{0pt plus 5cm}double trace (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a25e61176fea3c03f41f8a4524a3a08b0}


This function returns the trace of a square matrix. If the input matrix is not square, an error is thrown. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the trace of the matrix. 
\end{DoxyReturn}
\hypertarget{classDMatrix_a8483633c05422fa0beb4fcad7276152f}{
\index{DMatrix@{DMatrix}!triu@{triu}}
\index{triu@{triu}!DMatrix@{DMatrix}}
\subsubsection[{triu}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& triu (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a8483633c05422fa0beb4fcad7276152f}


This function extracts and return the triangular upper part of the input matrix A. The returned object has the same dimensions as the input object. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a45de81d6d9403a02c173fadc2ffb369a}{
\index{DMatrix@{DMatrix}!var@{var}}
\index{var@{var}!DMatrix@{DMatrix}}
\subsubsection[{var}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& var (
\begin{DoxyParamCaption}
\item[{{\bf DMatrix} \&}]{A, }
\item[{int}]{ntype = {\ttfamily 0}}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a45de81d6d9403a02c173fadc2ffb369a}


This function returns a row vector with the variance of each column of matrix A. If ntype is 0 (default) the result is normalised with (n-\/1), where n is the number of rows of A. Otherwise, the result is normalised with n. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
{\em ntype} & is the type of normalization, 0 (default) or 1. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a643b82daee87c5738faac272b56e8ea8}{
\index{DMatrix@{DMatrix}!vec@{vec}}
\index{vec@{vec}!DMatrix@{DMatrix}}
\subsubsection[{vec}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& vec (
\begin{DoxyParamCaption}
\item[{const {\bf DMatrix} \&}]{A}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a643b82daee87c5738faac272b56e8ea8}


This function returns a column vector made by stacking the columns of a matrix one below the other from left to right. 


\begin{DoxyParams}{Parameters}
{\em A} & is a \hyperlink{classDMatrix}{DMatrix} object. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}
\hypertarget{classDMatrix_a2150db6f40794cd7741043bcd593d2ce}{
\index{DMatrix@{DMatrix}!zeros@{zeros}}
\index{zeros@{zeros}!DMatrix@{DMatrix}}
\subsubsection[{zeros}]{\setlength{\rightskip}{0pt plus 5cm}{\bf DMatrix}\& zeros (
\begin{DoxyParamCaption}
\item[{long}]{n, }
\item[{long}]{m}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}friend\mbox{]}}}}
\label{classDMatrix_a2150db6f40794cd7741043bcd593d2ce}


This function returns a matrix full of zeros with specified numbers of rows and columns. 


\begin{DoxyParams}{Parameters}
{\em n} & is the desired number of rows \\
\hline
{\em m} & is the desired number of columns \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Reference to a temporary \hyperlink{classDMatrix}{DMatrix} object with the result of the operation 
\end{DoxyReturn}


\subsection{Member Data Documentation}
\hypertarget{classDMatrix_a7d862f142821d27ff3ca0620170428ba}{
\index{DMatrix@{DMatrix}!atype@{atype}}
\index{atype@{atype}!DMatrix@{DMatrix}}
\subsubsection[{atype}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf DMatrix::atype}\hspace{0.3cm}{\ttfamily  \mbox{[}protected\mbox{]}}}}
\label{classDMatrix_a7d862f142821d27ff3ca0620170428ba}
Flag to indicate type of allocation. type = 0 : allocated matrix type = 1 : non-\/allocated matrix, uses predefined array for storage \hypertarget{classDMatrix_a1b72a6547b064c5e262e5db9389b34f4}{
\index{DMatrix@{DMatrix}!mtype@{mtype}}
\index{mtype@{mtype}!DMatrix@{DMatrix}}
\subsubsection[{mtype}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf DMatrix::mtype}\hspace{0.3cm}{\ttfamily  \mbox{[}protected\mbox{]}}}}
\label{classDMatrix_a1b72a6547b064c5e262e5db9389b34f4}
Flag to indicate type of matrix mtype = 0 : normal matrix mtype = 1 : colon -\/ reference matrix 

The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
dmatrixv.h\end{DoxyCompactItemize}
